SinTan1729/chhoto-url
SinTan1729/chhoto-url
1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2025-02-05 13:52:33 -06:00
Code Issues Releases Activity

docs: Small changes to the README

Browse source
This commit is contained in:
Sayantan Santra 2025-01-05 16:25:08 +05:30
parent f1c1642976
commit 5183279cab
Signed by: SinTan1729
GPG key ID: 0538DD402EA50898
1 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -128,7 +128,7 @@ docker run -p 4567:4567 \
-e site_url="https://www.example.com" \ -e site_url="https://www.example.com" \
-d chhoto-url:latest -d chhoto-url:latest
``` ```
1.c Optionally, set an API key to activate JSON result mode (optional) 1.c Further, set an API key to activate JSON result mode (optional)
``` ```
docker run -p 4567:4567 \ docker run -p 4567:4567 \
@ -159,9 +159,11 @@ served through a proxy.
The application can be used from the terminal using something like `curl`. In all the examples The application can be used from the terminal using something like `curl`. In all the examples
below, replace `http://localhost:4567` with where your instance of `chhoto-url` is accessible. below, replace `http://localhost:4567` with where your instance of `chhoto-url` is accessible.
You can get the version of `chhoto-url` the server is running using `curl http://localhost:4567/api/version` and
get the siteurl using `curl http://localhost:4567/api/siteurl`. These routes are accessible without any authentication.
### Cookie validation ### Cookie validation
If you have set up If you have set up a password, first do the following to get an authentication cookie and store it in a file.
a password, first do the following to get an authentication cookie and store it in a file.
```bash ```bash
curl -X POST -d "<your-password>" -c cookie.txt http://localhost:4567/api/login curl -X POST -d "<your-password>" -c cookie.txt http://localhost:4567/api/login
``` ```
@ -188,8 +190,8 @@ The server will send a confirmation.
### API key validation ### API key validation
**This is required for programs that rely on a JSON response from Chhoto URL** **This is required for programs that rely on a JSON response from Chhoto URL**
In order to use API key validation, set the `api_key` environment variable. If this is not set, the API will default to cookie validation (see section above). In order to use API key validation, set the `api_key` environment variable. If this is not set, the API will default to cookie
If the API key is insecure, a warning will be outputted along with a generated API key which may be used. validation (see section above). If the API key is insecure, a warning will be outputted along with a generated API key which may be used.
To add a link: To add a link:
``` bash ``` bash
@ -205,16 +207,11 @@ To delete a link:
``` bash ``` bash
curl -X DELETE -H "X-API-Key: <YOUR_API_KEY>" http://localhost:4567/api/del/<shortlink> curl -X DELETE -H "X-API-Key: <YOUR_API_KEY>" http://localhost:4567/api/del/<shortlink>
``` ```
Where `<shortlink>` is name of the shortened link you would like to delete. For example, if the shortened link is `http://localhost:4567/example`, `<shortlink>` would be `example`. Where `<shortlink>` is name of the shortened link you would like to delete. For example, if the shortened link is
`http://localhost:4567/example`, `<shortlink>` would be `example`.
The server will output when the instance is accessed over API, when an incorrect API key is received, etc. The server will output when the instance is accessed over API, when an incorrect API key is received, etc.
In both modes, these routes are accessible:
You can get the version of `chhoto-url` the server is running using `curl http://localhost:4567/api/version` and
get the siteurl using `curl http://localhost:4567/api/siteurl`.
## Disable authentication ## Disable authentication
If you do not define a password environment variable when starting the docker image, authentication If you do not define a password environment variable when starting the docker image, authentication
will be disabled. will be disabled.