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: Add info about configuring Cache-Control header

Browse Source
This commit is contained in:
SinTan1729 2024-05-31 01:42:51 -05:00
parent 8ff4c3f24f
commit de9bc130d5
No known key found for this signature in database
GPG Key ID: EB3E68BFBA25C85F
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -133,6 +133,10 @@ 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.
By default, the server sends `no-cache` and `private` Cache-Control headers. To disable those,
set `cache_control_header` to `Disable`. It might help boost performance if served through a
proxy.
## 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.

24
compose.yaml
View File

@ -9,32 +9,36 @@ services:
ports: ports:
- 4567:4567 - 4567:4567
environment: environment:
# Change if you want to mount the database somewhere else # Change if you want to mount the database somewhere else.
# In this case, you can get rid of the db volume below # In this case, you can get rid of the db volume below
# and instead do a mount manually by specifying the location # and instead do a mount manually by specifying the location.
# - db_url=/urls.sqlite # - db_url=/urls.sqlite
# Change it in case you want to set the website name # Change it in case you want to set the website name
# displayed in front of the shorturls, defaults to # displayed in front of the shorturls, defaults to
# the hostname you're accessing it from # the hostname you're accessing it from.
# - site_url=https://www.example.com # - site_url=https://www.example.com
- password=$3CuReP4S$W0rD - password=$3CuReP4S$W0rD
# 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 # By default, the auto-generated pairs are adjective-name pairs.
# If you want UIDs, please change slug_style to UID # If you want UIDs, please change slug_style to UID.
# Supported values for slug_style are Pair and UID # Supported values for slug_style are Pair and UID.
# 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 # 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
# By default, the server sends `no-cache` and `private` Cache-Control
# headers. To disable those, change the following option to Disable.
# - cache_control_header=Enable
volumes: volumes:
- db:/urls.sqlite - db:/urls.sqlite
networks: networks: