docker/README.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

2024-07-05 11:24:29 +02:00
This repository helps you to set up a local Mobilizon and a local WordPress instance for developing within minutes. It is still early alpha, if you should try it and get stuck somewhere it most likely our fault, so please reach out to us, and we try to help you.
2023-12-09 12:54:38 +01:00
2023-12-15 15:13:03 +01:00
## Step by Step Guide
2023-12-20 14:27:23 +01:00
### 0. Requirements
2023-12-15 14:45:15 +01:00
- `make`
- `docker` and `docker-compose`
2023-12-09 12:54:38 +01:00
- `mkcert` to handle locally trusted SSL certificates.
2023-12-20 14:27:23 +01:00
### 1. Fetch the repository
```bash
git clone https://code.event-federation.eu/Event-Federation/docker.git docker && cd docker
```
### 2. Clone Mobilizon source relative to this repo
2023-12-09 12:54:38 +01:00
```bash
2023-12-15 15:13:03 +01:00
git clone https://framagit.org/framasoft/mobilizon.git mobilizon/mobilizon
2023-12-09 12:54:38 +01:00
```
2023-12-15 15:13:03 +01:00
### 3. Generate a SSL-cert
Generate a local SSL-certificate which is used for both WordPress and Mobilizon.
2023-12-09 12:54:38 +01:00
```bash
mkcert -install -cert-file certs/lan.pem -key-file certs/lan-key.pem wp.lan mz.lan
```
2023-12-15 15:13:03 +01:00
### 4. Add the two dummy domains to the /etc/hosts file on your machine:
2023-12-09 12:54:38 +01:00
```
127.0.0.1 wp.lan
127.0.0.1 mz.lan
```
2023-12-15 15:13:03 +01:00
### 5. Build Mobilizon
2024-07-05 11:24:29 +02:00
`make mobilizon_setup`
2023-12-09 12:54:38 +01:00
2023-12-15 15:13:03 +01:00
### 6. Start the docker containers
`make start`
2023-12-09 12:54:38 +01:00
2023-12-15 15:13:03 +01:00
### 7. Go to http://wp.lan and setup WordPress
2024-07-05 11:24:29 +02:00
Currently this has to be done manually:
- Go to https://wp.lan and enter dummy credentials.
2023-12-15 15:13:03 +01:00
- Install the WordPress plugins you need.
2023-12-09 12:54:38 +01:00
2023-12-15 15:13:03 +01:00
### 8. Create an administrator user for Mobilizon
2023-12-09 12:54:38 +01:00
```
2024-07-05 11:24:29 +02:00
make mobilizon_admins
2023-12-09 12:54:38 +01:00
```
2023-12-15 14:50:36 +01:00
### 9. Start developing and debugging
2024-07-05 11:24:29 +02:00
Get the logs via
2023-12-15 15:13:03 +01:00
- `docker-compose logs -f <container_name>`
- `make logs`