@@ -4,33 +4,58 @@ Deploy 120+ open-source web apps with one Docker command.
4
4
5
5
## ✨ Features
6
6
7
- - ** Easy to use** : Deploy your favorite apps with one command
8
- - ** Zero config** : No need to configure anything, just deploy
9
- - ** Secure** : Use Traefik and Let's Encrypt to secure your apps
10
- - ** Customizable** : Change the domain, the volume path, the version, etc.
11
- - ** Portainer support** : Use ` templates.json ` to deploy apps with Portainer
7
+ - 🚀 ** Easy to use** : Deploy your favorite apps with one command
8
+ - ⚡ ** Zero config** : No need to configure anything, just deploy
9
+ - 🔒 ** Secure** : Use Traefik and Let's Encrypt to secure your apps
10
+ - 🔧 ** Customizable** : Change the domain, the volume path, the version, etc.
11
+ - 🛳️ ** Portainer support** : Use ` templates.json ` to deploy apps with Portainer
12
12
13
13
## 📋 Requirements
14
14
15
- - Docker swarm
15
+ - Docker Swarm
16
16
- Traefik
17
17
18
- ## 🚀 Get started
18
+ ## 🚀 Installation
19
+
20
+ 1 . Install Docker
21
+
22
+ ``` bash
23
+ apt install -y docker.io
24
+ ```
25
+
26
+ 2 . Initialize Docker Swarm
19
27
20
28
``` bash
21
- # 1. Setup Docker Swarm
22
29
docker swarm init
30
+ ```
31
+
32
+ 3 . Deploy Traefik
23
33
24
- # 2. Deploy Traefik
34
+ ``` bash
25
35
docker network create -d overlay traefik-net
26
36
docker stack deploy -c stacks/traefik.yml traefik
37
+ ```
27
38
28
- # 3. Deploy a stack (ex: Nextcloud)
29
- DOMAIN=nextcloud.localhost docker stack deploy -c stacks/nextcoud.yml nextcloud
39
+ ## 📦 Usage
30
40
31
- # Go to https://nextcloud.localhost
41
+ Deploy your apps with one command, for example, to deploy [ Nextcloud] ( ./stacks/nextcloud.yml ) :
42
+
43
+ ``` bash
44
+ docker stack deploy -c stacks/nextcoud.yml nextcloud
32
45
```
33
46
47
+ Go to https://nextcloud.localhost and enjoy your app!
48
+
49
+ ## 🔧 Customization
50
+
51
+ You can customize the domain, the volume path or the version of your apps with environment variables, for example (with [ Ghost] ( ./stacks/ghost.yml ) ):
52
+
53
+ ``` bash
54
+ DOMAIN=example.com VERSION=5 VOLUME_PATH=/mnt/ docker stack deploy -c stacks/ghost.yml ghost
55
+ ```
56
+
57
+ Refer to the ` .yml ` files in the ` stacks ` directory to explore all available environment variables and customization options for each app if needed.
58
+
34
59
## 🎁 Support me
35
60
36
61
I'd love to work on this project, but my time on this earth is limited, support my work to give me more time!
0 commit comments