Skip to content

Commit 62485fc

Browse files
committed
imprv
1 parent 479fbd2 commit 62485fc

File tree

2 files changed

+28
-19
lines changed

2 files changed

+28
-19
lines changed

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
![HTTPS](https://img.shields.io/badge/HTTPS-Configured-green)
55
![PostgreSQL](https://img.shields.io/badge/Database-PostgreSQL-blue)
66
![Redis](https://img.shields.io/badge/Cache-Redis-red)
7+
![Plausible](https://img.shields.io/badge/Analytics-Plausible-purple)
78
![Website](https://img.shields.io/badge/Website-React%20App-blue)
89

910
This repository is a minimalistic setup for running services with Docker Compose behind Traefik and autogenerated `https` certificates.
@@ -96,18 +97,13 @@ The setup uses [Traefik](https://github.com/traefik/traefik), the cloud native a
9697

9798
You can always delete existing (if you don't need them) or add your own services, just make sure to apply necessary changes.
9899

99-
### Env variables
100+
### Services
100101

101-
Current setup requires you to fill in `.env` file with variables that are used in services.
102+
---
102103

103-
- `DOMAIN_NAME` - your registered domain.
104-
- `DO_AUTH_TOKEN` - Digital Ocean token that is going to be used for DNS challenge and generating https certificates. It's required by Traefik and they provide other options, you can find them [here](https://doc.traefik.io/traefik/https/acme/#providers). If you'd like to continue with Digital Ocean, then you can create a token in `Dashboard` -> `API` -> `Tokens/Keys`.
105-
- `ACME_EMAIL` - email that is used for [Let's Encrypt](https://letsencrypt.org) and `https` certificates.
106-
- `GITHUB_TOKEN` - `(optional)` github token for private repos.
104+
[PostgreSQL](https://www.postgresql.org) - open source object-relational database known for reliability and data integrity.
107105

108-
### Services
109-
110-
- [PostgreSQL](https://www.postgresql.org) - open source object-relational database known for reliability and data integrity. It uses [Bitnami Docker image](https://hub.docker.com/r/bitnami/postgresql).
106+
It uses [Bitnami Docker image](https://hub.docker.com/r/bitnami/postgresql).
111107

112108
<details>
113109
<summary>Env variables</summary>
@@ -118,7 +114,11 @@ Current setup requires you to fill in `.env` file with variables that are used i
118114

119115
</details>
120116

121-
- [Redis](https://redis.io) - open source, in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker. It uses [Bitnami Docker image](https://hub.docker.com/r/bitnami/redis).
117+
---
118+
119+
[Redis](https://redis.io) - open source, in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker.
120+
121+
It uses [Bitnami Docker image](https://hub.docker.com/r/bitnami/redis).
122122

123123
<details>
124124
<summary>Env variables</summary>
@@ -128,17 +128,15 @@ Current setup requires you to fill in `.env` file with variables that are used i
128128

129129
</details>
130130

131-
- [Plausible](https://plausible.io) - simple and privacy-friendly Google Analytics alternative
131+
---
132+
133+
[Plausible](https://plausible.io) - simple and privacy-friendly Google Analytics alternative.
132134

133-
> [Official docs](https://plausible.io/docs/self-hosting).
135+
[Official documentation](https://plausible.io/docs/self-hosting).
134136

135137
<details>
136138
<summary>Env variables</summary>
137139

138-
`.env` file:
139-
140-
- `PLAUSIBLE_POSTGRES_PASSWORD` - password for Plausible PostgreSQL.
141-
142140
`services/plausible/conf.env` file:
143141

144142
- `SECRET_KEY_BASE` - secret key of your app. Can be generated by running `openssl rand -base64 64 | tr -d '\n' ; echo`.
@@ -156,10 +154,23 @@ Current setup requires you to fill in `.env` file with variables that are used i
156154

157155
</details>
158156

159-
- [React App](https://backend.starters.dev) - simple [frontend app](https://github.com/starters-dev/backend.starters.dev-website).
157+
---
158+
159+
[React App](https://backend.starters.dev) - simple [frontend app](https://github.com/starters-dev/backend.starters.dev-website).
160+
161+
---
160162

161163
> more services will be added...
162164
165+
### Env variables
166+
167+
Current setup requires you to fill in `.env` file with variables that are used in services.
168+
169+
- `DOMAIN_NAME` - your registered domain.
170+
- `DO_AUTH_TOKEN` - Digital Ocean token that is going to be used for DNS challenge and generating https certificates. It's required by Traefik and they provide other options, you can find them [here](https://doc.traefik.io/traefik/https/acme/#providers). If you'd like to continue with Digital Ocean, then you can create a token in `Dashboard` -> `API` -> `Tokens/Keys`.
171+
- `ACME_EMAIL` - email that is used for [Let's Encrypt](https://letsencrypt.org) and `https` certificates.
172+
- `GITHUB_TOKEN` - `(optional)` github token for private repos.
173+
163174
## Enhancements
164175

165176
There are still some things I would like to add to the backend setup:

services/plausible/verify_emails.sh

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)