generated from coop-cloud/example
remove HTML_ROOT & update readme
Some checks failed
continuous-integration/drone/pr Build is failing
Some checks failed
continuous-integration/drone/pr Build is failing
This commit is contained in:
@ -6,7 +6,6 @@ DOMAIN=custom-html.example.com
|
||||
LETS_ENCRYPT_ENV=production
|
||||
|
||||
COMPOSE_FILE="compose.yml"
|
||||
HTML_ROOT=/usr/share/nginx/html
|
||||
|
||||
# Single Sign On via Traefik "file provider"
|
||||
#COMPOSE_FILE="$COMPOSE_FILE:compose.sso.yml"
|
||||
@ -16,7 +15,6 @@ HTML_ROOT=/usr/share/nginx/html
|
||||
#GIT_REPO_URL="https://git.coopcloud.tech/dalmationer/hexbomb.gay"
|
||||
#GIT_BRANCH=main
|
||||
#CRON_SCHEDULE="*/10 * * * *" # Default: every 10 minutes
|
||||
# HTML_ROOT=/git
|
||||
|
||||
# Optionally redirect the entire domain or a sub-path:
|
||||
# path under which you want to redirect all URLs (with trailing slash):
|
||||
|
||||
64
README.md
64
README.md
@ -28,6 +28,23 @@ Custom HTML website, served using Nginx.
|
||||
abra app cp YOURAPPDOMAIN index.html app:/usr/share/nginx/html
|
||||
```
|
||||
|
||||
## Downloading and auto-updating from a Git repository
|
||||
|
||||
To automatically pull website contents from a Git repository on a schedule:
|
||||
|
||||
1. `abra app config YOURAPPDOMAIN`
|
||||
2. Add or uncomment these lines and configure your repository and update schedule:
|
||||
```
|
||||
COMPOSE_FILE="$COMPOSE_FILE:compose.git-pull.yml"
|
||||
GIT_REPO_URL="https://git.coopcloud.tech/yourorg/yourrepo"
|
||||
GIT_BRANCH=main
|
||||
CRON_SCHEDULE="*/10 * * * *" # Default: every 10 minutes
|
||||
```
|
||||
3. `abra app deploy YOURAPPDOMAIN`
|
||||
4. As the git-pull service has `replicas: 0` in `compose.git-pull.yml` and doesn't run by itself. It requires either:
|
||||
- Deploying an instance of the [`coop-cloud/swarm-cronjob`] recipe on your server, OR
|
||||
- A manual cronjob on the server running: `docker service scale <app_domain_tld>_git=1`
|
||||
|
||||
## Allowing upload via SSH/SFTP
|
||||
To allow management of your site's files using scp, rsync or other SSH-based tools:
|
||||
1. If you don't already have one, generate an SSH keypair using `ssh-keygen`
|
||||
@ -42,6 +59,53 @@ To allow management of your site's files using scp, rsync or other SSH-based too
|
||||
4. Test the SSH connection: `ssh -p 2220 sftp@YOURAPPDOMAIN`
|
||||
5. You can copy local files into the server's web root with a command like: `scp -r -P 2220 * sftp@YOURAPPDOMAIN:/content`
|
||||
|
||||
## Redirect options
|
||||
|
||||
### Full redirect (of all URLs under specific path)
|
||||
|
||||
To redirect the entire domain or a specific path to another URL:
|
||||
|
||||
1. `abra app config YOURAPPDOMAIN`
|
||||
2. Add or uncomment these lines:
|
||||
```
|
||||
REDIRECT_FROM_PATH=/ # Path to redirect from (with trailing slash)
|
||||
REDIRECT_TO_URL=https://example.com/website/ # Target URL (with trailing slash)
|
||||
REDIRECT_TYPE=redirect # Use "redirect" (for HTTP 302) or "permanent" (for 301)
|
||||
```
|
||||
3. `abra app deploy YOURAPPDOMAIN`
|
||||
|
||||
This will redirect all requests matching `REDIRECT_FROM_PATH` to `REDIRECT_TO_URL`, carrying over the path. For example, `/blog/post` would redirect to `https://example.com/website/blog/post`.
|
||||
|
||||
### Fallback redirect for paths not matching a file
|
||||
|
||||
To serve static files normally but redirect requests for all non-existent paths to a dynamic site:
|
||||
|
||||
1. `abra app config YOURAPPDOMAIN`
|
||||
2. Add or uncomment these lines:
|
||||
```
|
||||
FALLBACK_REDIRECT_URL=https://dynamic-site.example.com
|
||||
FALLBACK_REDIRECT_TYPE=302
|
||||
```
|
||||
3. `abra app deploy YOURAPPDOMAIN`
|
||||
|
||||
This is useful for serving a static site alongside a dynamic one (that is running on a different [sub]domain) on the same domain. Existing static files are served directly, while missing URLs are redirected to the dynamic site with the full path preserved.
|
||||
|
||||
### Single-page application (SPA) handler
|
||||
|
||||
Similarly, to serve all non-existent paths with a single HTML file (common for React, Vue, etc.):
|
||||
|
||||
1. `abra app config YOURAPPDOMAIN`
|
||||
2. Add or uncomment this line:
|
||||
```
|
||||
SINGLE_PAGE_SITE_HANDLER=/index.html
|
||||
```
|
||||
3. `abra app deploy YOURAPPDOMAIN`
|
||||
|
||||
This will serve the contents `/index.html` (as a rewrite rather than a redirect) for any route that doesn't match an existing file, allowing client-side routing to work properly.
|
||||
|
||||
**Note:** `FALLBACK_REDIRECT_URL` and `SINGLE_PAGE_SITE_HANDLER` are mutually exclusive options.
|
||||
|
||||
|
||||
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
|
||||
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik
|
||||
[`coop-cloud/swarm-cronjob`]: https://git.coopcloud.tech/coop-cloud/swarm-cronjob
|
||||
|
||||
2
abra.sh
2
abra.sh
@ -1,2 +1,2 @@
|
||||
export NGINX_DEFAULT_CONF_VERSION=v10
|
||||
export NGINX_DEFAULT_CONF_VERSION=v11
|
||||
export ENTRYPOINT_CONF_VERSION=v4
|
||||
|
||||
@ -24,7 +24,6 @@ services:
|
||||
- "backupbot.backup.path=/usr/share/nginx/html"
|
||||
environment:
|
||||
- DEFAULT_CONF_FILE=/etc/nginx/conf.d/default.conf
|
||||
- HTML_ROOT
|
||||
- REDIRECT_FROM_PATH
|
||||
- REDIRECT_TO_URL
|
||||
- REDIRECT_TYPE
|
||||
|
||||
@ -8,7 +8,7 @@ server {
|
||||
#access_log /var/log/nginx/host.access.log main;
|
||||
|
||||
location / {
|
||||
root {{ env "HTML_ROOT" }};
|
||||
root /usr/share/nginx/html;
|
||||
index index.html index.htm;
|
||||
|
||||
{{ if env "REDIRECT_TO_URL" }}
|
||||
|
||||
Reference in New Issue
Block a user