@@ 1,18 1,22 @@
[gobwebs]
+# The listen address/port setings will be used by the main `links` service.
+# Other services are set in the [links] section below.
listen-address = localhost
listen-port = 8000
+
+# Set to whatever you want. It's just a convenience for feature flags, etc.
environment=development
# Options: debug, normal
# Default is debug
server-mode=debug
-# How to manage email.
+# How to manage email. Configured in [email]
# Options: console, smtp
# Default: console
email-service=console
-# File storage
+# File storage. Configured in [storage]
# Options: fs, s3
# Default: fs
storage-service=fs
@@ 29,7 33,7 @@ media-url=/media
admin-email=geeks@netlandish.com
# Default email to send from
-default-from-email=peter@netlandish.com
+default-from-email=noreply@domain.com
# Email addmin errors?
# Default: true
@@ 38,6 42,7 @@ email-admin-errors=true
# Language
default-language=es
+# Used to build URL's in the code base
scheme=http
domain=127.0.0.1:8000
@@ 95,11 100,16 @@ secret-key=XXXXX
bucket=bucketname
region=us-east-1
prefix=
-# acl should be a canned acl
+# ACL should be a canned ACL value. See
# https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl
-default-acl=private
+# this is not recommended and ACL's are disabled by default on new S3 buckets. Preferred
+# method is to use Policy's in S3 like services. However if you want per item ACL's, you
+# can use a default one with this.
+# default-acl=private
[access]
+# Entropy is to be used as an encryption key. The value be the AES key,
+# either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256.
entropy=Entropy value
[graphql]
@@ 111,18 121,21 @@ default-query-file=/path/to/default_query.graphql
# App specific settings
[links]
-# URL for the GraphQL API instance
+# URL for the GraphQL API instance (links-api service)
api-origin=http://127.0.0.1:8080/query
# Enable AutoTLS / SSL Cert management?
# Default true
auto-tls=true
# Where will SSL certs be stored. If empty, the value of `./cache` is used.
+# Be sure the service has write permissions on this directory
ssl-cert-cachedir=/var/www/.cache
## DNS CHECKS
-# Set to false to disable domain CNAME checks, defaults to true
+# Set to false to disable domain CNAME checks, defaults to true.
+# Used to verify a domain is configured correctly before accepting it for use
+# within the application. Checks against the CNAME domains below
domain-check-cname=true
# links service CNAME domain
@@ 134,9 147,9 @@ short-cname-domain=host.domain.com
# list (tree/bio) service CNAME domain
list-cname-domain=host.domain.com
-# What domains and listen details are used by the system services
-# links service will use the [gobwebs] listen-address and listen-port
-# settings
+# What domains and listen details are used by the system services.
+# The main `links` service will use the [gobwebs] listen-address and
+# listen-port settings
links-service-domain=domain.com
short-service-domain=domain.com
@@ 151,8 164,8 @@ api-service-domain=domain.com
api-listen-address=localhost
api-listen-port=8003
-# Optional domains service. Set this if you plan to use
-# domain checking via Caddy, tlstunnel, etc.
+# Optional links-domains service. Set this if you plan to use a reverse
+# proxy and do domain checking via Caddy, tlstunnel, etc.
domains-listen-address=localhost
domains-listen-port=8004
@@ 175,6 188,8 @@ home-url=
root-url=
[geo]
+# Path to GeoLite2 City (binary) map file. Free to download at
+# https://dev.maxmind.com/geoip/geolite2-free-geolocation-data/
path=
[billing]