From 5dd0fbb1b4ece670ea28bbda9569cb39757c4111 Mon Sep 17 00:00:00 2001 From: paige Date: Wed, 6 Nov 2024 23:14:10 +0000 Subject: [PATCH] clean up documentation --- README.md | 74 ++++--------------------------------------------------- 1 file changed, 5 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 9d6aeb9..016cc59 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,11 @@ # Instructions ## docker-compose -- if you are not starting from scratch. delete stale containers and: `docker rmi inspi4` and `docker volume rm inspi4_ssl` -- copy `config.env.exmaple` to `config.env` and edit -- optional: if you intend to link, copy `include.default.conf` to `include.conf` and edit (see linking section below.) -- start: `docker-compose -f docker-compose.standalone.yml up -d` also use the linked variant if you intend to link. - -- ~~`docker build -t inspi4 -t inspi4:latest .`~~ -- ~~`docker run -it --rm -e 'DEFAULT_BLOCK_HOST_MASK="nothing"' -net host inspi4`~~ - -# Optional -- ~~create a custom `links.conf`~~ -- ~~`docker run -it --rm -e 'DEFAULT_BLOCK_HOST_MASK="nothing"' -net host -v $(pwd)/links.conf:/etc/inspircd/links.conf:ro inspi4`~~ - -# Linking -- Run `docker exec -it ircd_ircd_linked_1 openssl x509 -sha256 -fingerprint -in /etc/ssl/inspircd/server.crt | tr -d ":" | tr '[:upper:]' '[:lower:]'` -to get the SSL fingerprints, the `fingerprint` refers to the remote SSL certificate fingerprint for each linking section. - -- On `hub.netcrave.network` add something like this to the `include.conf`: - -``` - - - -``` -- On `leaf.netcrave.network` add something like this to the `include.conf`: - -``` - - - -``` - -# Linking with services -- Doesn't work yet: https://github.com/atheme/atheme/issues/904 -``` - -``` +1. copy `config.env.exmaple` to `config.env` and edit +2. copy `include.conf.example` to `custom/include.conf` +3. follow steps from [#easyrsa] section +4. `docker-compose build` +5. `docker-compose up -d` # easyrsa On the hub: