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

docs: Include info about UID in docs

Browse Source
This commit is contained in:
SinTan1729 2024-03-31 00:51:10 -05:00
parent 088cd594a5
commit 841f877ee8
No known key found for this signature in database
GPG Key ID: EB3E68BFBA25C85F
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -116,8 +116,11 @@ docker run -p 4567:4567 \
-d chhoto-url:latest -d chhoto-url:latest
``` ```
You can also set the redirect method to Permanent 308 (default) or Temporary 307 by setting You can set the redirect method to Permanent 308 (default) or Temporary 307 by setting
the `redirect_method` variable to `TEMPORARY` or `PERMANENT` (it's matched exactly). the `redirect_method` variable to `TEMPORARY` or `PERMANENT` (it's matched exactly). By
default, the auto-generated links are adjective-name pairs. You can use UIDs 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.
## 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

7
compose.yaml
View File

@ -21,6 +21,13 @@ services:
# Pass the redirect method, if needed TEMPORARY and PERMANENT # Pass the redirect method, if needed TEMPORARY and PERMANENT
# are accepted values, defaults to PERMANENT # are accepted values, defaults to PERMANENT
# - redirect_method=TEMPORARY # - redirect_method=TEMPORARY
# By default, the auto-generated pairs are adjective-name pairs
# If you want UIDs, please change slug_style to UID
# Supported values for slug_style are "pair" and "UID"
# The length is 8 by default, and a minimum of 4 is allowed
# - slug_style=pair
# - slug_length=8
volumes: volumes:
- db:/urls.sqlite - db:/urls.sqlite
networks: networks: