mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-10 04:50:16 +02:00

colcrunch d825689da4 Add settings section to service docs. Remove references to settings.py. (#942 )

Standardized the addition of settings instructions.
Changed all references of local.py to a more generic 'auth project settings file'.
Included basic apache and nginx configs.
Include database creation steps.
Instruct users to restart gunicorn and celery after altering settings.
Include missing TS3 celerybeat schedule.

2018-02-21 20:39:54 -05:00

3.4 KiB

Raw Blame History

SMF

Overview

SMF is a free php-based forum.

Dependencies

SMF requires php installed in your web server. Apache has mod_php, NGINX requires php-fpm. More details can be found in the SMF requirements page.

Prepare Your Settings

In your auth project's settings file, do the following:

Add 'allianceauth.services.modules.smf', to your INSTALLED_APPS list
Append the following to the bottom of the settings file:

SMF Configuration

SMF_URL = '' DATABASES['smf'] = { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'alliance_smf', 'USER': 'allianceserver-smf', 'PASSWORD': 'password', 'HOST': '127.0.0.1', 'PORT': '3306', }

Setup

Download SMF

Using your browser, you can download the latest version of SMF to your desktop computer. All SMF downloads can be found at SMF Downloads. The latest recommended version will always be available at http://www.simplemachines.org/download/index.php/latest/install/.

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-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-13_install.zip

Now we need to move this to our web directory. Usually /var/www/forums.

sudo mv smf /var/www/forums

The web server needs read/write permission to this folder

sudo chown -R www-data:www-data /var/www/forums

Database Preparation

SMF needs a database. Create one:

mysql -u root -p
create database alliance_smf;
grant all privileges on alliance_smf . * to 'allianceserver'@'localhost';
exit;

Enter the database information into the DATABASES['smf'] section of your auth project's settings file.

Web Server Configuration

Your web server needs to be configured to serve Alliance Market.

A minimal apache config might look like:

<VirtualHost *:80>
    ServerName forums.example.com
    DocumentRoot /var/www/forums
    <Directory "/var/www/forums">
        DirectoryIndex index.php
    </Directory>
</VirtualHost>

A minimal nginx config might look like:

server {
    listen 80;
    server_name  forums.example.com;
    root   /var/www/forums;
    index  app.php;
    access_log  /var/logs/forums.access.log;

    location ~ \.php$ {
        try_files $uri =404;
        fastcgi_pass   unix:/tmp/php.socket;
        fastcgi_index  index.php;
        fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
        include fastcgi_params;
    }
}

Enter the web address to your forums into the SMF_URL setting in your auth project's settings file.

Preparing Auth

Once settings are entered, apply migrations and restart gunicorn and celery.

Web Install

Navigate to your forums address where you will be presented with an installer.

Click on the Install tab.

All the requirements should be met. Press Start Install.

Under Database Settings, set the following:

Database Type is MySQL
Database Server Hostname is 127.0.0.1
Database Server Port is left blank
Database Name is alliance_smf
Database Username is your auth MySQL user, usually allianceserver
Database Password is this user’s password

Follow the directions in the installer.

3.4 KiB Raw Blame History Unescape Escape

SMF