From 47ee43f6fb181391d9399352b11d65040fd8031b Mon Sep 17 00:00:00 2001
From: root <paige@paige.bio>
Date: Sun, 5 Jan 2025 14:39:20 +0000
Subject: [PATCH] update readme

---
 README.md      | 96 +++++++-------------------------------------------
 ssl/.gitignore |  2 ++
 2 files changed, 14 insertions(+), 84 deletions(-)
 create mode 100644 ssl/.gitignore

diff --git a/README.md b/README.md
index 7a8b803..16c8f6e 100644
--- a/README.md
+++ b/README.md
@@ -1,89 +1,17 @@
 # Instructions 
 
-## docker-compose 
-
-- Copy `config.env.example` to `config.env` and edit
-- Copy `include.default.conf` to `include.conf` and edit
+## Remote with TLS
+since atheme doesn't support TLS uplinks, stunnel has to be used for remote TLS encryption (this assumes stunnel is running on the hub already):
+- `cd stunnel/`
+- Copy `stunnel.conf.example` to `stunnel.conf` then edit
+- retrieve certificates from CA `see inspircd hub CA setup with easyrsa3`
 - `docker-compose up -d`
 
-## include.conf
+## docker-compose 
+- Copy `config.env.example` to `config.env` and edit
+- Copy `data/include.default.conf` to `data/include.conf` and edit
+- `docker-compose build`
+- `docker-compose up -d`
 
-```
-serverinfo {
-        name = "services.netcrave.network";
-        desc = "IRC Services";
-        numeric = "00A";
-        recontime = 10;
-        netname = "LameNet";
-        hidehostsuffix = "users.misconfigured";
-        adminname = "admin";
-        adminemail = "no-reply@services.netcrave.network";
-        registeremail = "no-reply@services.netcrave.network";
-        hidden;
-        mta = "/usr/sbin/sendmail";
-        loglevel = { admin; error; info; network; wallops; };
-        maxcertfp = 0;
-        maxlogins = 5;
-        maxusers = 5;
-        mdlimit = 30;
-        emaillimit = 10;
-        emailtime = 300;
-        auth = none;
-        casemapping = rfc1459;
-};
-
-uplink "irc.netcrave.network" {
-        host = "127.0.0.1";
-        port = 7001;
-        send_password = "changeme";
-        receive_password = "changeme";
-};
-
-operator "admin" {
-        operclass = "sra";
-        password = "changeme";
-};
-
-general {
-        permissive_mode;
-        helpchan = "#help";
-        helpurl = "https://www.netcrave.network";
-        verbose_wallops;
-        join_chans;
-        leave_chans;
-        secure;
-        uflags = { hidemail; };
-        cflags = { guard; verbose; };
-        raw;
-        flood_msgs = 7;
-        flood_time = 10;
-        ratelimit_uses = 5;
-        ratelimit_period = 60;
-        vhost_change = 30;
-        kline_time = 7;
-        kline_with_ident;
-        kline_verified_ident;
-        clone_time = 0;
-        commit_interval = 5;
-        db_save_blocking;
-        operstring = "is an IRC Operator";
-        servicestring = "is a Network Service";
-        default_clone_allowed = 5;
-        default_clone_warn = 4;
-        clone_identified_increase_limit;
-        uplink_sendq_limit = 1048576;
-        language = "en";
-
-        exempts {
-        };
-
-        allow_taint;
-        immune_level = immune;
-        show_entity_id;
-        load_database_mdeps;
-        hide_opers;
-        match_masks_through_vhost;
-        default_password_length = 16;
-};
-
-```
+## Anope migration 
+See `tools/` for `anope2atheme.php`. YMMV
diff --git a/ssl/.gitignore b/ssl/.gitignore
new file mode 100644
index 0000000..d6b7ef3
--- /dev/null
+++ b/ssl/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore