Update documentation to allow removal of wiki pages.

docs/installation/auth/apache.md

@@ -3,6 +3,8 @@
 
 AllianceAuth gets served using a Web Server Gateway Interface (WSGI) script. This script passes web requests to AllianceAuth which generates the content to be displayed and returns it. This means very little has to be configured in Apache to host AllianceAuth.
 
+In the interest of ~~laziness~~ time-efficiency, scroll down for example configs. Use these, changing the ServerName to your domain name.
+
 ### Required Parameters for AllianceAuth Core
 
 The AllianceAuth core requires the following parameters to be set:
@@ -58,12 +60,14 @@ You can supply your own SSL certificates if you so desire. The alternative is ru
    - [000-default](http://pastebin.com/HfyKpQNu)
    - [default-ssl](http://pastebin.com/2WCS5jnb)
 
-### No SSL or Cloudflare
+### No SSL Cloudflare, or LetsEncrypt
  - Apache 2.4 or newer:
    - [000-default.conf](http://pastebin.com/j1Ps3ZK6)
  - Apache 2.3 or older:
    - [000-default](http://pastebin.com/BHQzf2pj)
 
+To have LetsEncrypt automatically install SSL certs, comment out the three lines starting with `WSGI`, install certificates, then uncomment them in `000-default-ls-ssl.conf`
+
 ## Enabling and Disabling Sites
 
 To instruct apache to serve traffic from a virtual host, enable it:

docs/installation/auth/centos.md

@@ -5,9 +5,10 @@ It's recommended to update all packages before proceeding.
     `sudo yum upgrade`
     `sudo reboot`
 
-Now install all [dependencies](dependencies.md). For this guide you'll need the optional [JDK](dependencies.md) and [Apache](dependencies.md) sections as well.
+Now install all [dependencies](dependencies.md).
 
     sudo yum install xxxxxxx
+
 replacing the x's with the list of packages.
 
 Make sure redis is running before continuing:
@@ -28,9 +29,9 @@ Find the line which says `root    ALL=(ALL)       ALL` - beneath it add another
 
 **From this point on you need to be logged in as the allianceserver user**
 
-start your mariadb server `sudo systemctl start mariadb`
+Start your mariadb server `sudo systemctl start mariadb`
 
-secure your MYSQL / Maria-db server by typing `mysql_secure_installation `
+Secure your MYSQL / Maria-db server by typing `mysql_secure_installation `
 
 AllianceAuth needs a MySQL user account. Create one as follows, replacing `PASSWORD` with an actual secure password:
 

docs/installation/auth/cloudflare.md

@@ -1,8 +1,8 @@
-# CloudFlare
+# Cloudflare
 
 CloudFlare offers free SSL and DDOS mitigation services. Why not take advantage of it?
 
-## Setup Protection
+## Setup
 
 You’ll need to register an account on [CloudFlare’s site.](https://www.cloudflare.com/)
 
@@ -30,12 +30,6 @@ Now we need to configure the https redirect to force all traffic to https. Along
 
 ## Update Auth URLs
 
-Edit settings.py and change the following values:
+Edit settings.py and replace everything that has a HTTP with HTTPS (except anything with a port on the end, like `OPENFIRE_ADDRESS`)
- - FORUM_URL = `os.environ.get('AA_FORUM_URL', "http://forums.mydomain.com")` if forums are on a subdomain
- - IPBOARD_ENDPOINT = `os.environ.get('AA_IPBOARD_ENDPOINT', 'http://forums.mydomain.com/ipboard/interface/board/index.php')` if forums are on a subdomain
- - JABBER_URL = `os.environ.get('AA_JABBER_URL', "jabber.yourdomain.com")`
- - OPENFIRE_ADDRESS = `os.environ.get('AA_OPENFIRE_ADDRESS', "http://jabber.yourdomain.com:9090")`
- - MUMBLE_URL = `os.environ.get('AA_MUMBLE_URL', "mumble.yourdomain.com")`
- - TEAMSPEAK3_PUBLIC_URL = `os.environ.get('AA_TEAMSPEAK3_PUBLIC_URL', 'ts.yourdomain.com')`
 
 And there we have it. You’re DDOS-protected with free SSL.

docs/installation/auth/index.md

@@ -8,6 +8,7 @@
     centos
     settings
     apache
+    cloudflare
     supervisor
     quickstart
 ```

docs/installation/auth/ubuntu.md

@@ -50,7 +50,6 @@ Ensure you're on the latest version with the following:
 
 Python package dependencies can be installed from the requirements file:
 
-    sudo pip install requests>=2.9.1
     sudo pip install -r requirements.txt
 
 The settings file needs configuring. See [this lengthy guide](settings.md) for specifics.

docs/installation/services/ipboard3.md

@@ -1,16 +1,12 @@
 # IPBoard3
 
-Yes, you read that right. AllianceAuth only supports IPBoard 3, not the new shiny 4. Why? Because InvisionPower removed the API we used to manage it.
-
-Moving right along.
-
 You’re on your own for the initial install of IPBoard. It’s pretty much just download, unzip, and move to `/var/www/ipboard/`. Make sure to
 
     sudo chown -R www-data:www-data /var/www/ipboard
 
 a few times because it’s pretty finicky.
 
-You’ll need to add another alias in your [apache config](https://github.com/R4stl1n/allianceauth/wiki/Apache-Setup#additional-parameters-for-full-setup), this one for `/ipboard/` pointing to `/var/www/ipboard` and add another `<directory>` block for `/var/www/ipboard` with `Require all granted` or `Allow from all` depending on your apache version.
+You’ll need to add another alias in your apache config, this one for `/ipboard` pointing to `/var/www/ipboard` and add another `<directory>` block for `/var/www/ipboard` with `Require all granted` or `Allow from all` depending on your apache version.
 
 IPBoard needs a database table. Log in to mysql and run:
 
@@ -35,7 +31,7 @@ Copy the API key. Now edit your settings.py as follows:
  - IPBOARD_APIKEY is the key you just copied
  - IPBOARD_ENDPOINT is `http://yourdomain.com/ipboard/interface/board/index.php`
 
-Now enable IPBoard for Auth and/or Blue by editing the [booleans](#alliance-service-setup).
+Now enable IPBoard for Auth and/or Blue by editing the auth settings.
 
 Save and exit. Restart apache or gunicorn.
 

docs/installation/services/mumble.md

@@ -21,7 +21,7 @@ REQUIRED: To enable the ICE authenticator, edit the following:
 
  - `icesecretwrite=MY_CLEVER_PASSWORD`, obviously choosing a secure password
 
-To customize the database, edit the following:
+By default mumble operates on sqlite which is fine, but slower than a dedicated MySQL server. To customize the database, edit the following:
 
  - uncomment the database line, and change it to `database=alliance_mumble`
  - `dbDriver=QMYSQL`
@@ -30,7 +30,7 @@ To customize the database, edit the following:
  - `dbPort=3306`
  - `dbPrefix=murmur_`
 
-To name your root channel, uncomment and edit `registerName=` whatever cool name you want
+To name your root channel, uncomment and set `registerName=` to whatever cool name you want
 
 Save and close the file (control + O, control + X).
 
@@ -64,7 +64,7 @@ Edit `authenticator.ini` and change these values:
 
 Test your configuration by starting it: `python authenticator.py`
 
-#Running the Authenticator
+## Running the Authenticator
 
 The authenticator needs to be running 24/7 to validate users on Mumble. The best way is to run it in a screen much like celery:
 

docs/installation/services/openfire.md

@@ -14,7 +14,7 @@ One additional package is required - [openjdk8](http://askubuntu.com/questions/4
 ### Download Installer
 Openfire is not available through repositories so we need to get a debian from the developer.
 
-On your PC, naviage to the [Ignite Realtime downloads section](https://www.igniterealtime.org/downloads/index.jsp), and under Openfire select Linux, click on the debian file (2nd in list, ends with .deb).
+On your PC, naviage to the [Ignite Realtime downloads section](https://www.igniterealtime.org/downloads/index.jsp), and under Openfire select Linux, click on the debian file (2nd from bottom of list, ends with .deb).
 
 Retrieve the file location by copying the url from the “click here” link.
 
@@ -22,11 +22,11 @@ In the console, ensure you’re in your user’s home directory: `cd ~`
 
 Now download the package. Replace the link below with the link you got earlier.
 
-    wget https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire_3.10.2_all.deb
+    wget https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire_4.1.1_all.deb
 
 Now install from the debian. Replace the filename with your file name (the last part of the download url is the file name)
 
-    sudo dpkg -i openfire_3.10.2_all.deb
+    sudo dpkg -i openfire_4.1.1_all.deb
 
 ### Web Configuration
 The remainder of the setup occurs through Openfire’s web interface. Navigate to http://yourdomain.com:9090, or if you’re behind CloudFlare, go straight to your server’s IP:9090.
@@ -58,7 +58,7 @@ Once loaded, press the green plus on the right for `REST API`.
 
 Navigate the `Server` tab, `Sever Settings` subtab. At the bottom of the left navigation bar select `REST API`.
 
-Select `Enabled`, and `Secret Key Auth`. Enter the secret key from OPENFIRE_SECRET_KEY here.
+Select `Enabled`, and `Secret Key Auth`. Update Alliance Auth settings with this secret key as `OPENFIRE_SECRET_KEY`.
 
 ### Broadcast Plugin Setup
 

docs/installation/services/phpbb3.md

@@ -14,11 +14,11 @@ In the console, navigate to your user’s home directory: `cd ~`
 
 Now download using wget, replacing the url with the url for the package you just retrieved
 
-    wget https://www.phpbb.com/files/release/phpBB-3.1.6.zip
+    wget https://www.phpbb.com/files/release/phpBB-3.2.0.zip
 
 This needs to be unpackaged. Unzip it, replacing the file name with that of the file you just downloaded
 
-    unzip phpBB-3.1.6.zip
+    unzip phpBB-3.2.0.zip
 
 Now we need to move this to our web directory. Usually `/var/www/forums`.
 
@@ -47,7 +47,7 @@ You should see `Succesful Connection` and proceed.
 
 Enter administrator credentials on the next page.
 
-Everything from hereon out should be intuitive.
+Everything from here should be intuitive.
 
 phpBB will then write its own config file.
 
@@ -59,11 +59,11 @@ Before users can see the forums, we need to remove the install directory
 ### Enabling Avatars
 AllianceAuth sets user avatars to their character portrait when the account is created or password reset. We need to allow external URLs for avatars for them to behave properly. Navigate to the admin control panel for phpbb3, and under the `General` tab, along the left navigation bar beneath `Board Configuration`, select `Avatar Settings`. Set `Enable Remote Avatars` to `Yes` and then `Submit`.
 
-[Screenshot of this page](http://imgur.com/UOgaq6J)
+![location of the remote avatar setting](http://i.imgur.com/eWrotRX.png)
 
 You can allow members to overwrite the portrait with a custom image if desired. Navigate to `Users and Groups`, `Group Permissions`, select the appropriate group (usually `Member` if you want everyone to have this ability), expand `Advanced Permissions`, under the `Profile` tab, set `Can Change Avatars` to `Yes`, and press `Apply Permissions`.
 
-[Screenshot of this page](http://i.imgur.com/VGHwdxM.png)
+![location of change avatar setting](http://i.imgur.com/Nc6Rzo9.png)
 
 ## Setup Complete
 You’ve finished the steps required to make AllianceAuth work with phpBB. Play around with it and make it your own.

docs/installation/services/smf.md

@@ -14,11 +14,11 @@ In the console, navigate to your user’s home directory: `cd ~`
 
 Now download using wget, replacing the url with the url for the package you just retrieved
 
-    wget http://download.simplemachines.org/index.php?thanks;filename=smf_2-0-11_install.zip
+    wget http://download.simplemachines.org/index.php?thanks;filename=smf_2-0-13_install.zip
 
 This needs to be unpackaged. Unzip it, replacing the file name with that of the file you just downloaded
 
-    unzip smf_2-0-11_install.zip
+    unzip smf_2-0-13_install.zip
 
 Now we need to move this to our web directory. Usually `/var/www/forums`.
 

docs/installation/services/teamspeak3.md

@@ -0,0 +1,74 @@
+# Teamspeak 3
+
+## Overview
+Teamspeak3 is the most popular VOIP program for gamers.
+
+But have you considered using Mumble? Not only is it free, but it has features and performance far superior to Teamspeak3.
+
+## Dependencies
+All dependencies should have been taken care of during the AllianceAuth install.
+
+## Setup
+Sticking with it? Alright, I tried.
+
+### Download Installer
+To install we need a copy of the server. You can find the latest version from [this dl server](http://dl.4players.de/ts/releases/) (I’d recommed getting the latest stable version – find this version number from the [TeamSpeak site](https://www.teamspeak.com/downloads#)). Be sure to get a link to the linux version.
+
+From the console, ensure you’re in the user’s home directory: `cd ~`
+
+And now download the server, replacing the link with the link you got earlier.
+
+    http://dl.4players.de/ts/releases/3.0.13.6/teamspeak3-server_linux_amd64-3.0.13.6.tar.bz2
+
+Now we need to extract the file.
+
+    tar -xf teamspeak3-server_linux_amd64-3.0.13.6.tar.bz2
+
+### Create User
+Teamspeak needs its own user.
+
+    sudo adduser --disabled-login teamspeak
+
+### Install Binary
+Now we move the server binary somewhere more accessible and change its ownership to the new user.
+
+    sudo mv teamspeak3-server_linux_amd64 /usr/local/teamspeak
+    sudo chown -R teamspeak:teamspeak /usr/local/teamspeak
+
+### Startup
+Now we generate a startup script so teamspeak comes up with the server.
+
+    sudo ln -s /usr/local/teamspeak/ts3server_startscript.sh /etc/init.d/teamspeak
+    sudo update-rc.d teamspeak defaults
+
+Finally we start the server.
+
+    sudo service teamspeak start
+
+### Update Settings
+The console will spit out a block of text. **SAVE THIS**.
+
+Update the AllianceAuth settings file with the following from that block of text:
+ - `TEAMSPEAK3_SERVERQUERY_USER` is `loginname` (usually `serveradmin`)
+ - `TEAMSPEAK3_SERVERQUERY_PASSWORD` is `password`
+
+Save and reload apache. Restart celery workers as well.
+
+    sudo service apache2 reload
+
+If you plan on claiming the ServerAdmin token, do so with a different TeamSpeak client profile than the one used for your auth account, or you will lose your admin status.
+
+### Generate User Account
+And now we can generate ourselves a user account. Navigate to the services in AllianceAuth for your user account and press the checkmark for TeamSpeak 3.
+
+Click the URL provided to automatically connect to our server. It will prompt you to redeem the serveradmin token, enter the `token` from startup.
+
+### Groups
+
+Now we need to make groups. AllianceAuth handles groups in teamspeak differently: instead of creating groups it creates an association between groups in TeamSpeak and groups in AllianceAuth. Go ahead and make the groups you want to associate with auth groups, keeping in mind multiple TeamSpeak groups can be associated with a single auth group.
+
+Navigate back to the AllianceAuth admin interface (yourdomain.com/admin) and under `Services`, select `Auth / TS Groups`. In the top-right corner click `Add`.
+
+The dropdown box provides all auth groups. Select one and assign TeamSpeak groups from the panels below. If these panels are empty, wait a minute for the database update to run.
+
+## Setup Complete

docs/maintenance/index.md

@@ -6,6 +6,5 @@
 
     changelog
     troubleshooting
-    cloudflare
 
 ```

docs/maintenance/troubleshooting.md

@@ -3,7 +3,6 @@
 ## Something broken? Stuck on an issue? Can't get it set up?
 
 Start here:
- - read the [documentation](https://github.com/R4stl1n/allianceauth/wiki)
  - check the [issues](https://github.com/R4stl1n/allianceauth/issues?utf8=%E2%9C%93&q=is%3Aissue) - especially closed ones
  - check the [forums](https://forums.eveonline.com/default.aspx?g=posts&t=383030)
 
@@ -16,9 +15,7 @@ No answer?
 
 ### `pip install -r requirements.txt` is failing
 
-Most commonly, your repositories did not include the `requests` package. Install it and try again: `sudo pip install requests`
+Either you need to `sudo` that command, or it's a missing dependency. Check [the list](../installation/auth/dependencies.md), reinstall, and try again.
-
-Otherwise it's usually a missing dependency. Check [the list](../installation/auth/dependencies.md), reinstall, and try again.
 
 ### I'm getting an error 500 trying to connect to the website on a new install
 
@@ -26,7 +23,11 @@ Read the apache error log: `sudo nano /var/log/apache2/error.log`
 
 If it talks about failing to import something, google its name and install it.
 
-If it whines about being unable to configure logger, make sure the log directory is write-able: `chmod -R 777 /home/allianceserver/allianceauth/log`, then reload apache.
+If it whines about being unable to configure logger, see below. 
+
+### Failed to configure log handler
+
+Make sure the log directory is write-able: `chmod -R 777 /home/allianceserver/allianceauth/log`, then reload apache/celery/supervisor/etc.
 
 ### Groups aren't syncing to services
 
@@ -34,9 +35,7 @@ Make sure the background processes are running: `ps aux | grep celery` should re
 
 If that doesn't do it, try clearing the worker queue. First kill all celery processes as described above, then do the following:
 
-    sudo rabbitmqctl stop_app
+    redis-cli FLUSHALL
-    sudo rabbitmqctl reset
-    sudo rabbitmqctl start_app
     python manage.py celeryd --purge
 
 Press control+C once.

requirements.txt

@@ -23,6 +23,8 @@ django-redis>=4.4
 git+https://github.com/celery/django-celery
 
 git+git://github.com/nikdoof/python-ts3.git
-git+https://github.com/pyghassen/openfire-restapi
+
+# awating pyghassen/openfire-restapi #1 to fix installation issues
+git+https://github.com/adarnof/openfire-restapi
 
 git+https://github.com/adarnof/adarnauth-esi