httpaste/docs/guide/get-started.rst
Tiara Rodney 0d6c010cce feat: init
[skip ci]
2022-04-01 01:02:09 +02:00

70 lines
No EOL
2 KiB
ReStructuredText

Get Started
===========
Installation
------------
.. code-block:: shell
$ python3 -m pip install httpaste-victorykit
$ httpaste --help
Create configuration
--------------------
.. code-block:: shell
$ httpaste default-config --dump myconfig.ini
Run a local test server
-----------------------
.. code-block:: shell
$ httpaste standalone --config myconfig.ini --port 8080
* Serving Flask app 'httpaste' (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: off
* Running on all addresses.
WARNING: This is a development server. Do not use it in a production deployment.
* Running on http://localhost:8080/ (Press CTRL+C to quit)
Publish a Private Paste
-----------------------
.. code-block:: shell
$ echo 'My first private paste' | curl -F 'data=<-' \
-u myusername:mypassword \
http://localhost:8080/paste/private
http://localhost:8080/paste/private/UALUA9
.. note::
If the user does not exist, they will be created upon authentication.
Retrieve a Private Paste
------------------------
.. code-block:: shell
$ curl -u myusername:mypassword http://localhost:8080/paste/private/UALUA9
My first private paste
Publish a Public Paste
-----------------------
.. code-block:: shell
$ echo 'My first public paste' | curl -F 'data=<-' \
http://localhost:8080/paste/public
http://localhost:8080/paste/public/X4L39J
Retrieve a Public Paste
------------------------
.. code-block:: shell
$ curl http://localhost:8080/paste/public/X4L39J
My first public paste