tiararodney/httpaste
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add guides and summary

Browse source
This commit is contained in:
Tiara Rodney 2022-04-02 03:04:28 +02:00
parent 6b96bf8efb
commit 0b16acf68c
12 changed files with 146 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

51
docs/README.rst
View file

@ -1,38 +1,41 @@
httpaste
========
httpaste - versatile HTTP pastebin
==================================
.. only:: readme
![](docs/_assets/images/dog-gf2faaf3f6_1920.png)
![](docs/_assets/images/favpng_parrot-royalty-free-cartoon.png)
.. only:: not readme
.. image:: _assets/images/dog-gf2faaf3f6_1920.png
.. image:: _assets/images/favpng_parrot-royalty-free-cartoon.png
Simple and safe pasting over HTTP.
httpaste is a pastebin application for easily pasting and retrieving data over
HTTP from shell environments and web browsers. It is inspired by `sprunge.us`_
and `ix.io`_, but focuses on extendability, advanced security, with little to
no trade-off to simplicity. It can be hosted through WSGI, CGI, Fast CGI, or
as a standalone evaluation server. It offers multiple storage backends, such as
a filesystem backend, SQLite backend, MySQL backend, or MongoDB backend.
httpaste is a pastebin application for easily pasting and retrieving data over HTTP from shell environments and web browsers. It is inspired by sprunge.us and ix.io, but focuses on extendability and advanced security.
All pastes are being encrypted on the fly and can only be retrieved by an
authorized user, either through knowing the paste id of a public paste, or
having authentication credentials, as well as the paste id of a private paste.
This makes httpaste ideal as a pastebin for sensitive environments such as the
Tor network. Authentication credentials are created on-the-fly and don't require a sign-up process.
public and private pastes are supported. In any case, httpaste provides full anonymity, with each paste being stored encrypted.
httpaste supports output formatting for syntax highlighting (powered by
`pygments`_), as well as MIME type output manipulation, and input encoding.
Therefore httpaste can server as an anonymous object storage for small data.
Why
---
As a user: Sometimes we say and write stupid things. Things so stupid, that
others may even be offended. Others being so offended, that they wish to take
legal actions against you. Legal actions which infringe upon your rights for
privacy. Who is the others? Well, it's the
Public pastes: Only people you share the paste id with are able to view the paste. Public pastes aren't indexed publicly, so Public pastes are encrypted with their paste id and the paste id is only
stored as a hash. Therefore the httpaste application hoster is unable to view any pastes, unless he maliciously logs any of the HTTP requests.
Minute-based and 'burn-after-read' paste expiration are supported.
httpaste focuses on security through cryptography, making it a computationally intensive application.
.. include:: guide/get-started.rst
Documentation
-------------
The documentation can be found under `<https://victorykit.bitbucket.io/taskdog/>`_.
The documentation can be found under `<https://victorykit.bitbucket.io/httpaste/>`_.
Licensing
@ -51,11 +54,19 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
along with this program. If not, see <https://www.gnu.org/licenses/>.
This program uses licensed third-party software.
.. toctree::
:maxdepth: 1
:caption: More Information
ARCHITECTURE
CONTRIBUTING
CONTRIBUTING
.. _ix.io: http://ix.io/
.. _sprunge.us: http://sprunge.us
.. _pygments: https://pygments.org/
.. _icon: https://favpng.com/png_view/parrot-parrot-royalty-free-cartoon-png/gps7HM42