Skip to content

Commit

Permalink
chore: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johackim committed Oct 4, 2024
1 parent bb07e87 commit 08ddc8a
Showing 1 changed file with 37 additions and 12 deletions.
49 changes: 37 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,58 @@ Deploy 120+ open-source web apps with one Docker command.

## ✨ Features

- **Easy to use**: Deploy your favorite apps with one command
- **Zero config** : No need to configure anything, just deploy
- **Secure**: Use Traefik and Let's Encrypt to secure your apps
- **Customizable**: Change the domain, the volume path, the version, etc.
- **Portainer support**: Use `templates.json` to deploy apps with Portainer
- 🚀 **Easy to use**: Deploy your favorite apps with one command
- **Zero config** : No need to configure anything, just deploy
- 🔒 **Secure**: Use Traefik and Let's Encrypt to secure your apps
- 🔧 **Customizable**: Change the domain, the volume path, the version, etc.
- 🛳️ **Portainer support**: Use `templates.json` to deploy apps with Portainer

## 📋 Requirements

- Docker swarm
- Docker Swarm
- Traefik

## 🚀 Get started
## 🚀 Installation

1. Install Docker

```bash
apt install -y docker.io
```

2. Initialize Docker Swarm

```bash
# 1. Setup Docker Swarm
docker swarm init
```

3. Deploy Traefik

# 2. Deploy Traefik
```bash
docker network create -d overlay traefik-net
docker stack deploy -c stacks/traefik.yml traefik
```

# 3. Deploy a stack (ex: Nextcloud)
DOMAIN=nextcloud.localhost docker stack deploy -c stacks/nextcoud.yml nextcloud
## 📦 Usage

# Go to https://nextcloud.localhost
Deploy your apps with one command, for example, to deploy [Nextcloud](./stacks/nextcloud.yml):

```bash
docker stack deploy -c stacks/nextcoud.yml nextcloud
```

Go to https://nextcloud.localhost and enjoy your app!

## 🔧 Customization

You can customize the domain, the volume path or the version of your apps with environment variables, for example:

```bash
DOMAIN=example.com VERSION=5 VOLUME_PATH=/mnt/ docker stack deploy -c stacks/ghost.yml ghost
```

Refer to the `.yml` files in the `stacks` directory to explore all available environment variables and customization options for each app if needed.

## 🎁 Support me

I'd love to work on this project, but my time on this earth is limited, support my work to give me more time!
Expand Down

0 comments on commit 08ddc8a

Please sign in to comment.