mirror of
https://github.com/SinTan1729/chhoto-url
synced 2024-12-25 07:18:35 -06:00
docs: Some documentation about public-mode
This commit is contained in:
parent
0fce881654
commit
ed2be0e883
2 changed files with 9 additions and 0 deletions
|
@ -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
|
||||
i.e. only the hit is recorded, and nothing else.
|
||||
- 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
|
||||
generate short links locally.
|
||||
- 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_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
|
||||
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.
|
||||
|
|
|
@ -31,6 +31,10 @@ services:
|
|||
# The length is 8 by default, and a minimum of 4 is allowed
|
||||
# - slug_style=Pair
|
||||
# - 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:
|
||||
- db:/urls.sqlite
|
||||
networks:
|
||||
|
|
Loading…
Reference in a new issue