build: remove requirement to edit docker-compose.yml per-stage
This commit is contained in:
parent
201a3ca255
commit
276fdccf36
4 changed files with 67 additions and 20 deletions
57
README.md
57
README.md
|
@ -1,12 +1,58 @@
|
|||
ilo sitelen tu
|
||||
==============
|
||||
# ✍️ ilo sitelen tu
|
||||
|
||||
A rewriting proxy service for use as the backend of a live web mirroring service for resilient and robust access to your website.
|
||||
|
||||
---
|
||||
|
||||
Origin Configuration
|
||||
--------------------
|
||||
## 🏃 Running with Docker Compose
|
||||
|
||||
You can run the application using Docker Compose in different environments using the appropriate Compose files and
|
||||
profiles.
|
||||
|
||||
### 🔧 Production
|
||||
|
||||
To run in **production**, use only the base `docker-compose.yml` file:
|
||||
|
||||
```bash
|
||||
docker-compose -f docker-compose.yml up
|
||||
```
|
||||
|
||||
This will start the core services (rewriting proxy and redis backend) without exposing any development-specific
|
||||
configurations or ports.
|
||||
|
||||
### 🧪 Staging
|
||||
|
||||
To run in **staging**, include the `override` file which may expose additional ports or settings:
|
||||
|
||||
```bash
|
||||
docker-compose -f docker-compose.yml -f docker-compose.override.yml up
|
||||
```
|
||||
|
||||
This setup is useful for testing in an environment that closely mirrors production but includes conveniences like
|
||||
exposing the Redis port on localhost.
|
||||
|
||||
### 💻 Local Development
|
||||
|
||||
For **local development**, use the same staging command:
|
||||
|
||||
```bash
|
||||
docker-compose -f docker-compose.yml -f docker-compose.override.yml up
|
||||
```
|
||||
|
||||
### 🛠 Enabling the Legacy Updater Tool (Optional)
|
||||
|
||||
The Legacy Updater Tool is an optional service that can be enabled using the `legacy` profile.
|
||||
The tool requires [additional configuration](./legacy/README.md).
|
||||
|
||||
To include it, use the `--profile` argument to `docker compose`:
|
||||
|
||||
```bash
|
||||
docker-compose --profile legacy up
|
||||
```
|
||||
|
||||
Without the `--profile legacy` flag, the updater tool is disabled by default.
|
||||
|
||||
## ⚙️ Origin Configuration
|
||||
|
||||
Each origin is required to have a JSON configuration object available in the Redis backend under the key
|
||||
`jasima:config:<canonical host>`.
|
||||
|
@ -25,8 +71,7 @@ The following keys are meaningful in this object:
|
|||
|
||||
Note: the default case applies when the key is omitted.
|
||||
|
||||
Copyright
|
||||
---------
|
||||
## 🖋️ Copyright
|
||||
|
||||
Copyright © 2025 SR2 Communications Limited.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue