Skip to content

Commit bd7cd30

Browse files
ivylikethevineivylikethevine
committed
added embedded view of docker compose files as well as more READMEs
1 parent 954716f commit bd7cd30

File tree

34 files changed

+93
-12
lines changed

34 files changed

+93
-12
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ stacks/common.yaml
99

1010
# To prevent VPN configurations being committed
1111
*.ovpn
12+
wg*.conf
1213

1314
# Section for repositories cloned into stacks/ directory
1415
stacks/obico-server/

‎README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Read this project's README's as a wiki [here](https://ivylikethevine.github.io/s
3838

3939
#### To deploy
4040

41+
In depth instructions [here](resources/README.md).
42+
4143
Requires: git, docker, docker compose
4244

4345
Tested on: Linux Mint, Ubuntu, and Debian
@@ -95,6 +97,8 @@ cd /home/$USER/saffron/resources
9597

9698
## v0.35 List of Stacks & Services (35+ Apps, 40+ Containers)
9799

100+
[Stacks](stacks/README.md) rely on a customized [common.yaml.public] for correct permissions, time zones, and data directory mounts.
101+
98102
\*\* Names are lowercased per dockge stack naming requirements
99103

100104
- 🚧 [avahi](stacks/avahi/README.md) - Allows docker containers to access mdns on LAN.
@@ -103,15 +107,7 @@ cd /home/$USER/saffron/resources
103107

104108
- ✅ [dokemon](stacks/dokemon/README.md) - Web UI to manage docker containers/view logs/etc.
105109

106-
- ✅ [dockge](https://github.com/louislam/dockge) - Web UI to manage docker compose files (integral to `saffron`).
107-
108-
- <details>
109-
<h3>WebUI Dashboard</h3>
110-
<img src="resources/screenshots/dockge.webp" alt="dockge ui screenshot"/>
111-
112-
<img alt="x64 Version" src="https://img.shields.io/docker/v/louislam/dockge/latest?arch=amd64&label=x64">
113-
<img alt="Arm64 Version" src="https://img.shields.io/docker/v/louislam/dockge/latest?arch=arm64&label=arm64">
114-
</details>
110+
- &#x2705; [dockge](dockge.md) - Web UI to manage docker compose files (integral to `saffron`).
115111

116112
- &#x2705; [docsify](stacks/docsify/README.md) - Web UI to view this repo's `README.md`'s as a wiki reflecting local edits. See the [public](https://ivylikethevine.github.io/saffron) instance or visit <http://hostname.local:5001> (if the container is running).
117113

@@ -212,9 +208,11 @@ I've also made stacks using Lissy93's well maintained [portainer template repo](
212208

213209
- For other projects that use a docker compose file from locally build Dockerfiles, clone the repo into `/home/$USER/saffron/stacks`, then add `stacks/repoName/` to the `.gitignore` file. An alternative is to use either the `p-` or `dev-` prefix in the stack name to be ignored by git. See [editing .gitignore](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) for more information.
214210

211+
<!-- [filename](.gitignore ':include :type=code') -->
212+
215213
### Configuration
216214

217-
#### `common.yaml` (new in v0.25) <a id="common-yaml"></a>
215+
#### `common.yaml` <a id="common-yaml"></a>
218216

219217
By using a set of base "services"\*\* inside of `saffron/stacks/common.yaml`, we can limit the length of each docker compose file & allow for easy re-use of shared docker configurations, mainly:
220218

@@ -226,6 +224,8 @@ On install, saffron copies it's local `stacks/common.yaml.public` file to `stack
226224

227225
\*\* : These aren't full services since they have no images defined. As such, they can't run alone.
228226

227+
[filename](stacks/common.yaml.public ':include :type=code')
228+
229229
#### Env Files
230230

231231
This project has 2 types of `.env` files:

‎dockge.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
https://github.com/louislam/dockge
2+
3+
[filename](compose.yaml ':include :type=code')
4+
5+
<h3>WebUI Dashboard</h3>
6+
<img src="resources/screenshots/dockge.webp" alt="dockge ui screenshot"/>
7+
8+
<img alt="x64 Version" src="https://img.shields.io/docker/v/louislam/dockge/latest?arch=amd64&label=x64">
9+
<img alt="Arm64 Version" src="https://img.shields.io/docker/v/louislam/dockge/latest?arch=arm64&label=arm64">

‎resources/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[filename](install-saffron.sh ':include :type=code')
2+
3+
[filename](remove-saffron.sh ':include :type=code')
4+
5+
6+
[filename](settings.json ':include :type=code')
7+
8+
<!-- [filename](pre-commit ':include :type=code') -->

‎stacks/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[Live view of local common.yaml](common.yaml ':include :type=code')
2+
3+
[Default saffron common.yaml.public](common.yaml.public ':include :type=code')

‎stacks/avahi/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ Allows docker containers to access mdns on LAN.
99
## Architecture Compatibility
1010

1111
![x64](https://img.shields.io/docker/v/arcadiatechnology/crafty-4/latest?arch=amd64&label=x64) ![arm64](https://img.shields.io/docker/v/arcadiatechnology/crafty-4/latest?arch=arm64&label=arm64)
12+
13+
[filename](compose.yaml ':include :type=code')

‎stacks/crafty/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Easily deploy/manage minecraft servers.
1313
### WebUI Dashboard
1414

1515
![Crafty UI](../../resources/screenshots/crafty.webp)
16+
17+
[filename](compose.yaml ':include :type=code')

‎stacks/docsify/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,7 @@ Charty - https://charty.docsify.markbattistella.com/#/?id=docsify-charty
2323
KaTeX support - https://github.com/upupming/docsify-katex/tree/master
2424

2525
- surround equation with $$, not triple backtick
26+
27+
[filename](compose.yaml ':include :type=code')
28+
29+
<!-- [Dockerfile](Dockerfile ':include') -->

‎stacks/dokemon/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ Web UI to manage docker containers/view logs/etc.
1515
### WebUI Dashboard
1616

1717
![Dokemon UI](../../resources/screenshots/dokemon.webp)
18+
19+
[filename](compose.yaml ':include :type=code')

‎stacks/dozzle/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ Web UI to live docker container logs.
1515
### WebUI Dashboard
1616

1717
![Web UI](../../resources/screenshots/dozzle.webp)
18+
19+
[filename](compose.yaml ':include :type=code')

0 commit comments

Comments
 (0)