Docker-based wiki is not quite as fast as npm install wiki. We hope in exchange to make fewer steps from local experiments to publicly hosted services.
Step-by-step instructions for starting a local farm. We assume you are connected to the Net and already have some developer tools installed: git, docker, and docker-compose.
.
I still have too many steps in process for my liking. Every time I look again, I ask myself some questions. Writing down that dialog (maybe save my future self some time puzzling):
- Why do I manually create a volume in step 2? Could use a simple named volume in `docker-compose.yml` and save myself that step. I think I started this before I added the `.env` file which is also when the repo had a very long name. Those together would create an especially ugly volume name that made all the docs for backups and other things ugly - Self-signed certs? Every time I restart the `proxy` I get new certs. What if I used hashicorp vault to run my own Certificate Authority and install the root cert in my browser or OS? lot of work to avoid occasional nuisance. just as difficult (or more) to document. some vague security fear that teaching browsers to trust localtest.me is inviting abuse for speerphishing or similar.
# An imaginary alternative
# 1. install docker # 2. install and launch a local-farm curl https://raw.githubusercontent.com/fedwiki/local-farm/master/install.sh \ | bash # 3. point your browser at https://localtest.me
The `install.sh` script in step 2 might do something like this:
curl -sS \ https://url-to-current-version/wiki-tls.tar.gz \ | tar zx cd wiki-tls docker-compose up -d cat <<EOF open https://localtest.me use the following password to unlock the wiki EOF docker-compose logs farm \ | awk -F\' '/admin:/ {print $2; exit;}'
Sadly the first thing you would see is the browser security warning for the self-signed cert. I think there are advantages to having a reverse proxy included in the default install. Browsers are clearly getting more aggressive about requiring https. Hoping we can learn remedies for the pains of security. We can use locally the same tools used publicly. That consistency will ease moving content from local to public wiki.
* [ ] TODO: customize Tips for Administrators for Docker specifics
.
Contrast Clean Fast Install in Docker