aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorThomas Vanbesien <tvanbesi@proton.me>2026-06-03 17:16:48 +0200
committerThomas Vanbesien <tvanbesi@proton.me>2026-06-03 17:49:21 +0200
commit8511f9d5c5d37f66239b571cf2a2b19c97705edf (patch)
treeb4779eaf91f122154201a79af29aaee40f8172e4 /readme.md
parentba3a7bc94421f93818f9196bd8a2c32eb7d9d940 (diff)
downloadnet_services-8511f9d5c5d37f66239b571cf2a2b19c97705edf.tar.gz
net_services-8511f9d5c5d37f66239b571cf2a2b19c97705edf.zip
docs: update README
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md47
1 files changed, 27 insertions, 20 deletions
diff --git a/readme.md b/readme.md
index 39db06b..5fe390d 100644
--- a/readme.md
+++ b/readme.md
@@ -1,37 +1,44 @@
# net_services
-A stack of services exposed over the network.
-
-The services run in Docker containers and are routed through Nginx.
+A stack of services exposed over the network, running in Docker containers.
Sensitive data is not stored on the disk when containers start. It is copied into a tmpfs within the container.
+## Requirements
+
+- `docker`
+- `mkcert` for local CA certificate generation
+- `htpasswd` for generating credentials for nginx
+- `tar`
+
## How-to
1. Create a `.env`; see `example.env`
-1. Build and run the services
+2. Initialize the host
+
+ ```bash
+ ./tools/net_services init
+ ```
- ```
- ./tools/build
- docker compose up
- ```
+3. Add Radicale user (optional)
-1. Add Radicale user
+ ```bash
+ htpasswd -B "${HOST__RADICALE_USERS_DIR}"/.htpasswd username
+ ```
- You can add as many as you want.
+4. Run the services
- ```
- htpasswd ${HOST__RADICALE_USERS_DIR}/.htpasswd username
- ```
+ ```bash
+ docker compose up
+ ```
-1. Access the services
+5. Access the services
- You may have to adapt the URLs to the configured published ports.
+ You may have to adapt the URLs to the configured published ports.
- - https://git.localhost
- - https://dav.localhost
- - https://sync.localhost
+ - <https://git.localhost>
+ - <https://dav.localhost>
+ - <https://sync.localhost>
- It is highly recommended to configure authentication for the Syncthing GUI
- if it exposed to the network.
+ It is highly recommended to configure authentication for the Syncthing GUI if it is exposed to the network.