SinTan1729/chhoto-url
SinTan1729/chhoto-url
1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2025-04-19 03:10:00 -05:00
Code Issues Releases Activity

docs: Added instructions for disabling the frontend

Browse source
This commit is contained in:
Sayantan Santra 2025-04-10 14:17:22 -05:00
parent 2c8f47c0cb
commit 97b56c40ae
Signed by: SinTan1729
GPG key ID: 0538DD402EA50898
2 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -47,7 +47,8 @@ for small. URL means, well... URL. So the name simply means Small URL.
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, and automatic dark mode. - Has a mobile friendly UI, and automatic dark mode.
- Has a public mode, where anyone can add links without authentication. Deleting - Has a public mode, where anyone can add links without authentication. Deleting
or listing available links will need admin access using the password. or listing available links will need admin access using the password. It's also
possible to completely disable the frontend.
- 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.
@ -146,7 +147,8 @@ the `slug_style` variable to `UID`. You can also set the length of those slug by
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 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. links. Listing existing links or deleting links will need admin access using the password. To
completely disable the frontend, set `disable_frontend` to `True`.
By default, the server sends no Cache-Control headers. You can set custom `cache_control_header` By default, the server sends no Cache-Control headers. You can set custom `cache_control_header`
to send your desired headers. It must be a comma separated list of valid to send your desired headers. It must be a comma separated list of valid

3
compose.yaml
View file

@ -59,6 +59,9 @@ services:
# In case you want to provide public access to adding links (and not # In case you want to provide public access to adding links (and not
# delete, or listing), change the following option to Enable. # delete, or listing), change the following option to Enable.
# - public_mode=Disable # - public_mode=Disable
# In case you want to completely disable the frontend, change the following
# to True.
# - disable_frontend=False
# By default, the server sends no Cache-Control headers. You can supply a # By default, the server sends no Cache-Control headers. You can supply a
# comma separated list of valid header as per RFC 7234 §5.2 to send those # comma separated list of valid header as per RFC 7234 §5.2 to send those