Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update monica docs #2386

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Update monica docs #2386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions monica/content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ where `%%REPO%%` is the name of the service in your `docker-compose.yml` file.

## Configuration using environment variables

The Monica image will use environment variables to setup the application. See [Monica documentation](https://github.com/monicahq/monica/blob/main/.env.example) for common used variables you should setup.
The Monica image will use environment variables to setup the application. See [Monica documentation](https://github.com/monicahq/monica/blob/4.x/.env.example) for common used variables you should setup.

## Running the image with docker-compose

See some examples of docker-compose possibilities in the [example section](%%GITHUB-REPO%%/blob/master/.examples).
See some examples of docker-compose possibilities in the [example section](%%GITHUB-REPO%%/blob/main/.examples).

---

Expand All @@ -79,7 +79,7 @@ Make sure to pass in values for `APP_KEY` variable before you run this setup.
1. Create a `docker-compose.yml` file

```yaml
version: "3.4"
version: "3.9"

services:
app:
Expand All @@ -89,7 +89,7 @@ Make sure to pass in values for `APP_KEY` variable before you run this setup.
ports:
- 8080:80
environment:
- APP_KEY=
- APP_KEY= # Generate with `echo -n 'base64:'; openssl rand -base64 32`
- DB_HOST=db
- DB_USERNAME=monica
- DB_PASSWORD=secret
Expand All @@ -98,7 +98,7 @@ Make sure to pass in values for `APP_KEY` variable before you run this setup.
restart: always

db:
image: mysql:5.7
image: mariadb:11
environment:
- MYSQL_RANDOM_ROOT_PASSWORD=true
- MYSQL_DATABASE=monica
Expand Down Expand Up @@ -135,28 +135,28 @@ Make sure to pass in values for `APP_KEY` variable before you run this setup.

When using FPM image, you will need another container with a webserver to proxy http requests. In this example we use nginx with a basic container to do this.

1. Download `nginx.conf` and `Dockerfile` file for nginx image. An example can be found on the [`example section`](%%GITHUB-REPO%%/blob/master/.examples/supervisor/fpm/web/)
1. Download `nginx.conf` and `Dockerfile` file for nginx image. An example can be found on the [`example section`](%%GITHUB-REPO%%/blob/main/.examples/full/fpm/web/)

```sh
mkdir web
curl -sSL https://raw.githubusercontent.com/monicahq/docker/master/.examples/nginx-proxy/web/nginx.conf -o web/nginx.conf
curl -sSL https://raw.githubusercontent.com/monicahq/docker/master/.examples/nginx-proxy/web/Dockerfile -o web/Dockerfile
curl -sSL https://raw.githubusercontent.com/monicahq/docker/main/.examples/full/web/nginx.conf -o web/nginx.conf
curl -sSL https://raw.githubusercontent.com/monicahq/docker/main/.examples/full/web/Dockerfile -o web/Dockerfile
```

The `web` container image should be pre-build before each deploy with: `docker-compose build`.

2. Create a `docker-compose.yml` file

```yaml
version: "3.4"
version: "3.9"

services:
app:
image: monica:fpm
depends_on:
- db
environment:
- APP_KEY=
- APP_KEY= # Generate with `echo -n 'base64:'; openssl rand -base64 32`
- DB_HOST=db
- DB_USERNAME=monica
- DB_PASSWORD=secret
Expand All @@ -175,7 +175,7 @@ When using FPM image, you will need another container with a webserver to proxy
restart: always

db:
image: mysql:5.7
image: mariadb:11
environment:
- MYSQL_RANDOM_ROOT_PASSWORD=true
- MYSQL_DATABASE=monica
Expand Down Expand Up @@ -218,4 +218,4 @@ One way to expose your Monica instance is to use a proxy webserver from your hos

### Using a proxy webserver container

See some examples of docker-compose possibilities in the [example section](%%GITHUB-REPO%%/blob/master/.examples) to show how to a proxy webserver with ssl capabilities.
See some examples of docker-compose possibilities in the [example section](%%GITHUB-REPO%%/blob/main/.examples) to show how to a proxy webserver with ssl capabilities.