From 7e63d61ef03177a0fc9a0fe2dbd56c6c7b4092d3 Mon Sep 17 00:00:00 2001 From: psychobunny Date: Fri, 25 Apr 2014 18:03:41 -0400 Subject: [PATCH] finished porting apache docs --- docs/configuring/proxies/apache.rst | 41 +++++++++++++++++++---------- docs/configuring/proxies/nginx.rst | 6 ++--- docs/make.bat | 2 +- 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/docs/configuring/proxies/apache.rst b/docs/configuring/proxies/apache.rst index 4ad59ada78..7d26f17de6 100644 --- a/docs/configuring/proxies/apache.rst +++ b/docs/configuring/proxies/apache.rst @@ -1,10 +1,11 @@ -Configuring apache as a proxy to NodeBB -====================================== +Configuring apache as a proxy +============================= -# Prerequisites to making this work: +**Prerequisites to making this work:** Apache 2.4.x -### What if I'm on 2.2.x (Debian/Ubuntu)? +What if I'm on 2.2.x (Debian/Ubuntu)? +------------------------------------ you need to manually compile and add the module "mod_proxy_wstunnel" to the Apache 2.2 branch. If you're running Ubuntu or Debian, you're likely on the 2.2 branch of code. @@ -12,23 +13,31 @@ The following guide will assist with that if you're on Debian or Ubuntu. This is http://www.amoss.me.uk/2013/06/apache-2-2-websocket-proxying-ubuntu-mod_proxy_wstunnel/ -#### NOTE: On ubuntu, if you’re missing the ./configure file -You need to first run ./buildconf. After this is complete, you will then be able to use ./confugure. +NOTE: On ubuntu, if you’re missing the ./configure file +------------------------------------ +You need to first run ./buildconf. After this is complete, you will then be able to use ./configure. ->automake & libtool package was needed too. ->apt-get install automake libtool +**automake & libtool package was needed too.** -**** -# Enable the necessary modules +.. code:: + + apt-get install automake libtool + + +Enable the necessary modules +----------------------------- 1. sudo a2enmod proxy 2. sudo a2enmod proxy_html 3. sudo a2enmod proxy_wstunnel -## Add the config to Apache +Add the config to Apache +----------------------------- The next step is adding the configuration to your virtualhost.conf file, typically located in /etc/apache2/sites-available/. The below configuration assumes you've used 4567 (default) port for NobeBB installation. It also assumes you have the bind address set to 127.0.0.1. +.. code:: + ProxyRequests off @@ -47,8 +56,11 @@ The next step is adding the configuration to your virtualhost.conf file, typical The last thing you need to be sure of is that the config.json in the NodeBB folder has use_port: false. Otherwise some functionality will not work properly. -**** -## Example nodebb/config.json + +Example nodebb/config.json +----------------------------- + +.. code:: json { "base_url": "http://www.yoursite.com", @@ -68,4 +80,5 @@ The last thing you need to be sure of is that the config.json in the NodeBB fold "relative_path": "" } ->Change the domain and dont use the secret in the example above. \ No newline at end of file + +**Change the domain and dont use the secret in the example above.** \ No newline at end of file diff --git a/docs/configuring/proxies/nginx.rst b/docs/configuring/proxies/nginx.rst index d2a1f80434..e29ed7ed30 100644 --- a/docs/configuring/proxies/nginx.rst +++ b/docs/configuring/proxies/nginx.rst @@ -1,7 +1,7 @@ -Configuring nginx as a proxy to NodeBB -====================================== +Configuring nginx as a proxy +============================ -NodeBB by default runs on port `4567`, meaning that builds are usually accessed using a port number in addition to their hostname: +NodeBB by default runs on port ``4567``, meaning that builds are usually accessed using a port number in addition to their hostname: http://example.org:4567 diff --git a/docs/make.bat b/docs/make.bat index b2c541f7a5..8ab906add1 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -1,6 +1,6 @@ @ECHO OFF -rmdir /s /q _build +REM rmdir /s /q _build REM Command file for Sphinx documentation