mylloon.fr/README.md
Mylloon 9f95eb2b6b
All checks were successful
ci/woodpecker/push/publish Pipeline was successful
Rework (#35)
- Style rework
- Update dependencies to latest

Close #33
Close #34

Reviewed-on: #35
Co-authored-by: Mylloon <kennel.anri@tutanota.com>
Co-committed-by: Mylloon <kennel.anri@tutanota.com>
2023-10-15 20:58:20 +02:00

91 lines
2 KiB
Markdown

# EWP
Easy WebPage generator
[![dependency status](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/mylloon.fr/status.svg)](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/mylloon.fr)
[![status-badge](https://ci.mylloon.fr/api/badges/Anri/mylloon.fr/status.svg)](https://ci.mylloon.fr/Anri/mylloon.fr)
See [issues](https://git.mylloon.fr/Anri/mylloon.fr/issues)
## Use Docker Compose
```yaml
version: "3.9"
services:
ewp:
image: git.mylloon.fr/anri/mylloon.fr:latest
container_name: EWP
volumes:
- /here/your/path/config:/app/config
- /here/your/path/data:/app/data
ports:
- 80:8080
restart: unless-stopped
```
<details>
<summary>Do you want to make the site available on Tor as well?</summary>
```yaml
version: "3.9"
services:
tor:
image: goldy/tor-hidden-service:latest
container_name: Website_tor
network_mode: bridge
links:
- ewp
environment:
EWP_TOR_SERVICE_HOSTS: "80:ewp:8080"
EWP_TOR_SERVICE_VERSION: "3"
volumes:
- tor-keys:/var/lib/tor/hidden_service/
secrets:
- source: ewp
target: ewp
mode: 0400
restart: unless-stopped
ewp:
image: git.mylloon.fr/anri/mylloon.fr:latest
container_name: Website
network_mode: bridge
hostname: ewp
volumes:
- /here/your/path/ewp/app/config:/app/config
- /here/your/path/ewp/app/data:/app/data
ports:
- 99:8080
restart: unless-stopped
volumes:
tor-keys:
driver: local
# Use https://github.com/cathugger/mkp224o to generate a key
secrets:
ewp:
file: /here/your/path/ewp/hidden_service/hs_ed25519_secret_key
```
You can tell the Tor Browser that you are offering an `onion` link by specifying
your address in the `config.toml` file.
```toml
onion = "http://youraddress.onion/"
```
</details>
## Example of [`config.toml`](./config/config.toml)
```toml
mail = "your.mail at host.com"
lang = "lang"
onion = "http://youraddress.onion/"
app_name = "Nickname"
name = "Firstname"
fullname = "Fullname"
```