From a47312466d797b442e6a2816a8e16299ced68e01 Mon Sep 17 00:00:00 2001 From: Michiel de Jong <michiel@unhosted.org> Date: Fri, 17 Oct 2014 13:13:06 +0100 Subject: [PATCH] add a few FIXME messages to the README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f7677dd..494d6e4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ -## Prerequisites to work on this project: +## IndieHosters + +This repository contains the confd and bash scripts we use to control our servers. +It can run inside Vagrant (see below; FIXME: check whether these instruction currently work) or +[deploy to a server](doc/getting-started-as-a-hoster.md) (FIXME: update those instructions to +prescribe less folder structure, explain static https+smtp hosting, and check if they currently +work). + +## Prerequisites to work on this project using vagrant: - [vagrant](http://www.vagrantup.com/) - [virtualbox](https://www.virtualbox.org/) - optional: [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) - run `vagrant plugin install vagrant-hostsupdater` to install ## Get started: -- Put a TLS certificate (self-signed is fine, but make sure you have [public, intermediate, and private all concatenated into one .pem file](https://www.digitalocean.com/community/tutorials/how-to-implement-ssl-termination-with-haproxy-on-ubuntu-14-04)) in /data/per-user/indiehosters.dev/combined.pem on the host system. -- Test it with `openssl s_server -cert /data/per-user/indiehosters.dev/combined.pem -www` ```bash vagrant up @@ -14,7 +20,7 @@ vagrant up Wait for the provisioning to finish (~40mins), and go to your browser: https://indiehosters.dev -### If you want to add another wordpress instance apart from indiehosters.dev: +### FIXME: this is outdated: If you want to add another nginx instance apart from indiehosters.dev: - For e.g. example.dev, put a cert for it in /data/per-user/example.dev/combined.pem on the host system. - Test it with `openssl s_server -cert /data/per-user/example.dev/combined.pem -www` -- GitLab