diff --git a/docs.d/HOW-TO-INSTALL.md b/docs.d/HOW-TO-INSTALL.md index 17cea91..0cbfde6 100644 --- a/docs.d/HOW-TO-INSTALL.md +++ b/docs.d/HOW-TO-INSTALL.md @@ -1,46 +1,47 @@ # Per-platform Installation -## Ubuntu 18.04LTS (prebuilt via tor and canonical) +All installations are currently being built from fresh sources for +reasons of development and keeping up to date with core, evolving +features. As such, installations make take extensive time to build, +especially on slower machines. + +## Raspbian + +* `sudo apt-get install -y git` +* `git clone https://github.com/alecmuffett/eotk.git` +* `cd eotk` +* `./opt.d/build-raspbian-stretch.sh` + +## Ubuntu 18.04LTS Install a `ubuntu-18.04.2-live-server-amd64.iso` server instance; and then: * `git clone https://github.com/alecmuffett/eotk.git` * `cd eotk` -* `./opt.d/install-everything-on-ubuntu-18.04.sh` - * this includes a full update +* `./opt.d/build-ubuntu-18.04.sh` -## macOS Mojave (prebuilt via homebrew) +## macOS Mojave Install [Homebrew](https://brew.sh); and then: * `git clone https://github.com/alecmuffett/eotk.git` * `cd eotk` -* `./opt.d/install-everything-on-macos.sh` +* `./opt.d/build-macos-mojave.sh` -## Raspbian (manual builds) +## FreeBSD 12.1 -Serially, installation takes about 1h45m on a PiZero, or about 30m on -a Pi3b. These figures should improve when recent Tor updates sediment -into Raspbian; scripts are supplied for Raspbian "Stretch". +Install a base server, install `pkg install git`, and then: -* `sudo apt-get install -y git` * `git clone https://github.com/alecmuffett/eotk.git` * `cd eotk` -* `./opt.d/build-nginx-on-raspbian-stretch.sh` -* `./opt.d/build-tor-on-raspbian-stretch.sh` -* `./opt.d/install-onionbalance-on-raspbian-stretch.sh` +* `./opt.d/build-freebsd-12.1.sh` -## Other Platform Outline Requirements +## Other Platform Requirements -EOTK requires recent `tor` and also `nginx` with the following modules -enabled; EOTK may need to be told about the modules via -`set nginx_modules_dirs ...` - -* `headers_more` -* `ngx_http_substitutions_filter_module` -* `http_sub` -* `http_ssl` -* Lua and/or LuaJIT (ideally from OpenResty) +EOTK requires recent `tor` and also recent `openresty` with the +`ngx_http_substitutions_filter_module` NGINX module enabled. They +simply need to be accessible in $PATH. The above "build" scripts +simply supply that. # Dealing With OnionBalance And Load-Balancing