readme.markdown

# INTRO #

This project aims to create centralized forum-like discussion platform with
anonymity in mind.

Main repository: https://bitbucket.org/neko259/neboard/

Site: http://neboard.me/

# INSTALLATION #

1. Download application and move inside it:

`hg clone https://bitbucket.org/neko259/neboard`

`cd neboard`

If you wish to use *decentral* version, change branch to *decentral*:

`hg up decentral`

2. Install all application dependencies:

Some minimal system-wide depenencies:

* python3
* pip/pip3
* jpeg

Python dependencies:

`pip3 install -r requirements.txt`

You can use virtualenv to speed up the process or avoid conflicts.

3. Setup a database in `neboard/settings.py`. You can also change other settings like search engine.

Depending on configured database and search engine, you need to install corresponding dependencies manually.

Default database is *sqlite*, default search engine is *whoosh*.

4. Setup SECRET_KEY to a secret value in `neboard/settings.py
5. Run `./manage.py migrate` to apply all migrations
6. Apply config changes to `boards/config/config.ini`. You can see the default settings in `boards/config/default_config.ini`
7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys

# RUNNING #

You can run the server using django default embedded webserver by running:

    ./manage.py runserver <address>:<port>

See django-admin command help for details.

Also consider using wsgi or fcgi interfaces on production servers.

When running for the first time, you need to setup at least one section tag.
Go to the admin page and manually create one tag with "required" property set.

# UPGRADE #

1. Backup your project data.
2. Copy the project contents over the old project directory
3. Run migrations by `./manage.py migrate`

You can also just clone the mercurial project and pull it to update

# CONCLUSION #

Enjoy our software and thank you!