1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2025-02-05 13:52:33 -06:00

Improve documentation for the "port" and "site_url" env variables

This commit is contained in:
SolomonTechnology 2025-01-14 00:25:49 +10:00 committed by GitHub
parent af1685bb70
commit db8417d919
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -7,6 +7,8 @@ services:
restart: unless-stopped restart: unless-stopped
container_name: chhoto-url container_name: chhoto-url
ports: ports:
# If you changed the "port" environment variable, adjust accordingly
# The number after the colon should match the "port" environment variable
- 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.
@ -18,11 +20,17 @@ services:
# a copy of your database.) # a copy of your database.)
- db_url=/db/urls.sqlite - db_url=/db/urls.sqlite
# Change it in case you want to set the website name # Change this if your server URL is not "http://localhost"
# displayed in front of the shorturls, defaults to # This must not be surrounded by quotes. For example:
# the hostname you're accessing it from. # site_url="https://www.example.com" incorrect
# site_url=https://www.example.com correct
# This is important to ensure Chhoto URL outputs the shortened link with the correct URL.
# - site_url=https://www.example.com # - site_url=https://www.example.com
# Change this if you are running Chhoto URL on a port which is not 4567.
# This is important to ensure Chhoto URL outputs the shortened link with the correct port.
# - port=4567
- password=TopSecretPass - password=TopSecretPass
# This needs to be set in order to use programs that use the JSON interface of Chhoto URL. # This needs to be set in order to use programs that use the JSON interface of Chhoto URL.