mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-29 15:06:26 +02:00
Optimized .mds and meta/main.yml for client-wireguard roles and refactored README.md of Docker Roles
This commit is contained in:
14
roles/docker-listmonk/Installation.md
Normal file
14
roles/docker-listmonk/Installation.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Installation and Configuration
|
||||
|
||||
## Initial Database Setup
|
||||
After the first setup, run the following command to initialize the Listmonk database:
|
||||
```bash
|
||||
docker compose run --rm application ./listmonk --install
|
||||
```
|
||||
|
||||
## Start Services
|
||||
|
||||
Use the following command to start Listmonk services:
|
||||
```bash
|
||||
docker-compose -p listmonk up -d --force-recreate
|
||||
```
|
@@ -6,42 +6,12 @@ This role deploys the Listmonk application using Docker. Listmonk is a high perf
|
||||
- Docker and Docker Compose should be installed on your system.
|
||||
- Make sure that the required ports are available and not used by other services.
|
||||
|
||||
## Installation and Configuration
|
||||
|
||||
1. **Clone the Repository**:
|
||||
- Ensure you have the latest version of this playbook from the repository.
|
||||
|
||||
2. **Configure Variables**:
|
||||
- Set your desired configurations in `vars/main.yml`. This includes the path to your Docker Compose files and any other relevant variables.
|
||||
|
||||
3. **Run the Playbook**:
|
||||
- Execute the ansible playbook to set up Listmonk.
|
||||
|
||||
4. **Initial Database Setup**:
|
||||
- After the first setup, run the following command to initialize the Listmonk database:
|
||||
```bash
|
||||
docker compose run --rm application ./listmonk --install
|
||||
```
|
||||
|
||||
5. **Configure Reverse Proxy** (Optional):
|
||||
- If you are using a reverse proxy, configure it as per your domain settings in the `nginx-docker-reverse-proxy` role.
|
||||
|
||||
6. **Start Services**:
|
||||
- Use the following command to start Listmonk services:
|
||||
```bash
|
||||
docker-compose -p listmonk up -d --force-recreate
|
||||
```
|
||||
## Upgrade
|
||||
```bash
|
||||
docker compose run application ./listmonk --upgrade
|
||||
```
|
||||
|
||||
## Configuration Files
|
||||
|
||||
- **docker-compose.yml**: Defines the Docker setup for Listmonk and its database.
|
||||
- **config.toml**: Contains the application settings including the database connection, admin credentials, and server settings.
|
||||
|
||||
## Further Information
|
||||
## 📚 Other Resources
|
||||
- For detailed installation instructions and configuration options, visit the [Listmonk Installation Documentation](https://listmonk.app/docs/installation/).
|
||||
- You can also find more information on the [Listmonk GitHub Repository](https://github.com/knadh/listmonk/).
|
||||
|
||||
|
5
roles/docker-listmonk/Upgrade.md
Normal file
5
roles/docker-listmonk/Upgrade.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Upgrade
|
||||
|
||||
```bash
|
||||
docker compose run application ./listmonk --upgrade
|
||||
```
|
Reference in New Issue
Block a user