Documentation: Adding initial ReadTheDocs documentation.

docs/index.md

@@ -0,0 +1,22 @@
+# Elgg Multisite Documentation
+
+[Elgg Multisite](https://elgg-multisite.com) is a tool that lets you run and manage 
+multiple independent [Elgg](https://elgg.org) powered social networks off of a single 
+installation of the code base. You can easily add, enable and disable sites, and even 
+configure which plugins are available to each network independently.
+
+
+## What can I do with it?
+
+You can do everything that you can do with Elgg, but with the 
+ability to create new networks on demand. This will for example 
+let you:
+
+* Set up your own version of Ning or Buddypress
+* In your organisation or institution, easily set up Elgg 
+  sites for each department.
+* ... etc...
+
+This is the canonical documentation for the project.
+
+* [Installing Elgg Multisite](install/index.md)

docs/install/index.md

@@ -0,0 +1,5 @@
+
+# Installing Elgg Multisite
+
+* [Instructions](instructions.md)
+* [System requirements](requirements.md)

docs/install/instructions.md

@@ -0,0 +1,36 @@
+# Usage
+
+The basic concept is that you set up one PRIVATE domain/site on your apache host
+that has ```/multisite/``` as its docroot, then set up a PUBLIC wildcard domain which has ```/elgg/```
+as its docroot.
+
+If you want an example of how to set it up, take a look at the configuration of the vagrant build.
+
+## Basic Setup
+
+* Create a database and install ```multisite/schema/multisite_mysql.sql```
+* Create a database user with
+  * The ability to create databases
+  * The ability to grant privileges on those databases
+* Modify the ```$CONFIG->multisite->db_*``` configuration in elgg/elgg-config/settings.php with these database settings
+* Configure a PRIVATE domain to use ```/multisite/``` as a docroot
+* Configure a PUBLIC wildcard domain to use ```/elgg/``` docroot
+* Make sure ```/data/``` is writable by your webserver
+* Visit your private domain & set up your first user and user domains
+
+## Vagrant build
+
+If you want to start playing with this quickly, you can run the vagrant build.
+
+* Install vagrant
+* Modify your ```hosts``` file (/etc/hosts on linux)
+  * Set "elgg-multisite" to point to the IP in your Vagrantfile (192.168.33.35 by default)
+  * Set "whatever.multi", "whatever2.multi", etc... to point to the same
+* Make sure ```/data/``` is writable by your webserver
+* ```vagrant up```
+* Go to http://elgg-multisite and set up your admin user
+  * Log in admin
+  * Create your whatever.multi domain
+* Visit http://whatever.multi
+
+Note: Provisioning will destroy any existing management database, so careful if you're re-provisioning an existing box!

docs/install/requirements.md

@@ -0,0 +1,9 @@
+
+# System requirements
+
+Elgg Multisite _requires_ the following server components:
+
++ A Web Server that supports URL rewriting (Apache + mod_rewrite recommended).
++ If you are using Apache, you also need to make sure support for .htaccess is enabled (using [the AllowOverride All directive](https://help.ubuntu.com/community/EnablingUseOfApacheHtaccessFiles)).
++ PHP 7.0 or above.
++ MySQL / MariaDB

mkdocs.yml

@@ -0,0 +1,9 @@
+site_name: Elgg Multisite Documentation
+theme: readthedocs
+markdown_extensions:
+ - admonition
+pages:
+- ['index.md', 'Elgg Multisite Documentation']
+- ['install/index.md', 'Installing and upgrading Elgg Multisite', 'Introduction']
+- ['install/instructions.md', 'Installing and upgrading Elgg Multisite', 'Installation instructions']
+- ['install/requirements.md', 'Installing and upgrading Elgg Multisite', 'System requirements']