From f3dcb9179b853b67e94f14e1daeeaacb4ad24f25 Mon Sep 17 00:00:00 2001 From: Alec Muffett Date: Tue, 18 May 2021 13:42:31 +0100 Subject: [PATCH] commit: docs.d/QUICK-START.md. --- README.md | 4 ---- docs.d/QUICK-START.md | 55 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 4 deletions(-) create mode 100644 docs.d/QUICK-START.md diff --git a/README.md b/README.md index 9164324..605b7d9 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,6 @@ login credentials of any kind. Please refer to the [How To Install](docs.d/HOW-TO-INSTALL.md) guide, and the other documents in [that folder](docs.d/). -## What's Changed? - -Please refer to the [Changelog](docs.d/CHANGELOG.md). - ## Help I'm Stuck! Ping @alecmuffett on Twitter, or log an `Issue`, above. diff --git a/docs.d/QUICK-START.md b/docs.d/QUICK-START.md new file mode 100644 index 0000000..7d6f914 --- /dev/null +++ b/docs.d/QUICK-START.md @@ -0,0 +1,55 @@ +# Quick Start For Experimentation + +## Step 1: install EOTK and build the necessary executables + +See [the instructions](HOW-TO-INSTALL.md). + +## Step 2: create a template-config file + +Create a file named `myproject.tconf` that contains: +``` +# boilerplate, adjust if needed +set nginx_resolver 8.8.8.8 1.1.1.1 ipv6=off +set nginx_cache_seconds 60 +set nginx_cache_size 64m +set nginx_tmpfile_size 8m +set log_separate 1 + +# preserve this domain name in free text or email addresses +set preserve_csv save,mydomain\\.com,i,mydomain.com + +set project myproject +hardmap %NEW_V3_ONION% mydomain.com +``` + +...and amend the values of `mydomain` and `com` +(if you are not using a `.com` top level domain) +throughout that file. + +## Step 3: generate an actual configuration + +Run: +``` +eotk config myproject.tconf +``` +...which will create `myproject.conf` and populate it with onion addresses. + +## Step 4: generate startup scripts + +Run: +``` +eotk script +``` +...which will generate start-on-boot and cronjob-housekeeping scripts; read them for installation instructions. + +## Step 5: start your server + +Run: +``` +eotk start myproject +``` +...to start your server; then do: +``` +eotk maps myproject +``` +...to see what onion address to connect to.