@@ -4,13 +4,11 @@ SuperStack is **Docker-native**, so deployments are simple, consistent, and
44portable. The goal is that only ` compose.yaml ` and secrets need to exist on the
55remote server.
66
7- ## Prepare your Application
7+ ## 🧱 1. Build Your Images
88
9- Services that are built (they have a ` build: ` section in ` compose.yaml ` ), add
10- your own container repository image URIs (e.g. your Docker Hub or GitHub
11- Container Registry account), for example:
9+ If a service has a ` build: ` section, add your own image name and version tag:
1210
13- ``` yaml title="compose.yaml"
11+ ``` yaml title="compose.yaml" hl_lines="5"
1412services :
1513 caddy :
1614 build :
@@ -25,49 +23,45 @@ docker compose build
2523docker compose push
2624```
2725
28- ## 📦 Deploy
26+ ## 📦 2. Copy to Server
2927
30- Copy ` compose.yaml ` to the server :
28+ Copy your ` compose.yaml ` to the remote host :
3129
3230``` sh
3331scp compose.yaml youruser@yourserver:
3432```
3533
36- ### Secrets
34+ ### 3. Set Secrets
3735
38- The app also needs your secrets (passwords, keys, etc.).
36+ Your app will need credentials such as database passwords or API keys.
37+ Choose one of these approaches:
3938
40- There are a few options:
39+ 1 . ** ` .env ` file ** — simplest for manual deploys.
4140
42- 1 . Put secrets in a ` .env ` file on the server, alongside your compose.yaml.
43- Convenient but Less secure. Be sure to ` chmod 600 .env ` .
44- 1 . Set environment variables in the the ` docker compose ` command. Inconvenient.
45- Be sure to disable shell history.
46- 1 . Use environment injection in CI/CD.
41+ ``` sh
42+ chmod 600 .env
43+ ```
44+
45+ 2 . ** Environment variables** — pass them directly to the command line.
46+ 3 . ** CI/CD injection** — good for automated pipelines.
4747
48- ## 🚀 Launch your Stack
48+ ## 🚀 Launch the App
4949
50- Bring up the stack :
50+ Start the application on the server :
5151
5252``` sh
5353docker compose pull
5454docker compose up -d
5555```
5656
57- ---
58-
59- That’s it — your backend is live.
60-
61- This type of rolling deployment makes it hard to test before going live and to
62- rollback, and can have some downtime while upgrading. Consider reading the Wiki
63- page on [ Advanced Deployments] ( ) .
64-
65- ## Github Actions Workflow
66-
67- TODO
57+ Your backend is now live. 🚀
6858
6959---
7060
71- ## ➕ What Now?
61+ ## 🧭 Next Steps
62+
63+ This setup replaces the stack in place.
7264
73- Add to your app by following guides in the [ Wiki] ( https://github.com/explodinlabs/superstack/wiki ) .
65+ If you want zero-downtime deployments, rollback support, or blue-green testing,
66+ see the Wiki page: [ Advanced
67+ Deployments] ( https://github.com/explodinlabs/superstack/wiki ) .
0 commit comments