docker/README.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

2023-12-20 14:23:40 +01: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
### 1. 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.
- Currently we only support Debian and Arch based linux distributions.
2023-12-09 12:54:38 +01:00
2023-12-15 15:13:03 +01:00
### 2. Clone Mobilizon source
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
`make 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
Currently this has to be done manually:
- Go to http://wp.lan and enter dummy credentials.
- 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
```
2023-12-20 14:23:40 +01:00
make admins
2023-12-09 12:54:38 +01:00
```
2023-12-15 14:50:36 +01:00
2023-12-15 15:13:03 +01:00
### 9. Start developing and debuggin
Get the logs via
- `docker-compose logs -f <container_name>`
- `make logs`