readonly/mirror-chhoto-url
1
0
Fork 0
mirror of https://github.com/minoplhy/chhoto-url.git synced 2024-11-24 17:56:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Some documentation about public-mode

Browse Source
This commit is contained in:
SinTan1729 2024-05-28 18:20:09 -05:00
parent 0fce881654
commit ed2be0e883
No known key found for this signature in database
GPG Key ID: EB3E68BFBA25C85F
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -45,6 +45,8 @@ for small. URL means, well... URL. So the name simply means Small URL.
- Counts number of hits for each short link in a privacy respecting way - Counts number of hits for each short link in a privacy respecting way
i.e. only the hit is recorded, and nothing else. i.e. only the hit is recorded, and nothing else.
- Has a mobile friendly UI. - Has a mobile friendly UI.
- Has a public mode, where anyone can add links without authentication. Deleting
or listing available links will need admin access using the password.
- Allows setting the URL of your website, in case you want to conveniently - Allows setting the URL of your website, in case you want to conveniently
generate short links locally. generate short links locally.
- Links are stored in an SQLite database. - Links are stored in an SQLite database.
@ -128,6 +130,9 @@ default, the auto-generated links are adjective-name pairs. You can use UIDs by
the `slug_style` variable to `UID`. You can also set the length of those slug by setting the `slug_style` variable to `UID`. You can also set the length of those slug by setting
the `slug_length` variable. It defaults to 8, and a minimum of 4 is supported. the `slug_length` variable. It defaults to 8, and a minimum of 4 is supported.
To enable public mode, set `public_mode` to `Enable`. With this, anyone will be able to add
links. Listing existing links or deleting links will need admin access using the password.
## Instructions for CLI usage ## Instructions for CLI usage
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.

4
compose.yaml
View File

@ -31,6 +31,10 @@ services:
# The length is 8 by default, and a minimum of 4 is allowed # The length is 8 by default, and a minimum of 4 is allowed
# - slug_style=Pair # - slug_style=Pair
# - slug_length=8 # - slug_length=8
# In case you want to provide public access to adding links (and not
# delete, or listing), change the following option to Enable
# - public_mode=Disable
volumes: volumes:
- db:/urls.sqlite - db:/urls.sqlite
networks: networks: