Skip to content

Commit

Permalink
docs: cleanup and update
Browse files Browse the repository at this point in the history
  • Loading branch information
raisedadead committed Jan 16, 2025
1 parent 9b465e6 commit d1a3c8e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion stacks/api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Usage

This stack defines all the services for the API. Name the stacks as per the environment ex: `prd-api`, etc. Set up the env values from the `.env` file withing the Portainer UI.
This stack defines all the services for the API. Name the stacks as per the environment ex: `prd-api`, etc. Set up the env values from the `.env.sample` file within the Portainer UI.

**Caddyfile**

Expand Down
2 changes: 1 addition & 1 deletion stacks/news/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Usage

This stack defines all the services for the JAMStack news apps. Name the stacks as per the environment ex: `prd-news`, etc. Set up the env values from the `.env` file withing the Portainer UI.
This stack defines all the services for the JAMStack news apps. Name the stacks as per the environment ex: `prd-news`, etc. Set up the env values from the `.env.sample` file within the Portainer UI.
4 changes: 3 additions & 1 deletion stacks/oncall/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## Usage

This stack defines all the services for the housekeeping apps. See comments in the stack file for details.
This stack defines all the services for the housekeeping apps. See comments in the stack file for details. Note that for credentials we use the host docker `config.json` file. This requires the update service to be running on the same host (typically the manager node).

Also note that these credentials need to be updated if they expire. This file is located at `~/.docker/config.json`.

0 comments on commit d1a3c8e

Please sign in to comment.