readme.markdown
66 lines
| 1.8 KiB
| text/x-markdown
|
MarkdownLexer
|
r433 | # INTRO # | ||
This project aims to create centralized forum-like discussion platform with | ||||
anonymity in mind. | ||||
Main repository: https://bitbucket.org/neko259/neboard/ | ||||
|
r434 | |||
|
r433 | Site: http://neboard.me/ | ||
# INSTALLATION # | ||||
|
r1535 | 1. Download application and move inside it: | ||
`hg clone https://bitbucket.org/neko259/neboard` | ||||
`cd neboard` | ||||
|
r1523 | |||
|
r1535 | 2. Install all application dependencies: | ||
Some minimal system-wide depenencies: | ||||
|
r1523 | |||
|
r1535 | * python3 | ||
* pip/pip3 | ||||
* jpeg | ||||
Python dependencies: | ||||
`pip3 install -r requirements.txt` | ||||
You can use virtualenv to speed up the process or avoid conflicts. | ||||
|
r1523 | |||
|
r1535 | 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. | ||||
|
r1728 | Default database is *sqlite*, default search engine is *simple*. | ||
|
r1535 | |||
4. Setup SECRET_KEY to a secret value in `neboard/settings.py | ||||
5. Run `./manage.py migrate` to apply all migrations | ||||
|
r1831 | 6. Apply config changes to `boards/config/settings.ini`. You can see the default settings in `boards/config/default_config.ini`(do not delete or overwrite it). | ||
|
r1535 | 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys | ||
|
r433 | |||
# RUNNING # | ||||
|
r1523 | You can run the server using django default embedded webserver by running: | ||
|
r434 | |||
|
r433 | ./manage.py runserver <address>:<port> | ||
|
r434 | |||
|
r1523 | See django-admin command help for details. | ||
|
r434 | |||
|
r433 | Also consider using wsgi or fcgi interfaces on production servers. | ||
|
r1523 | 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. | ||||
|
r453 | # UPGRADE # | ||
1. Backup your project data. | ||||
|
r1155 | 2. Copy the project contents over the old project directory | ||
3. Run migrations by `./manage.py migrate` | ||||
|
r453 | |||
You can also just clone the mercurial project and pull it to update | ||||
|
r433 | # CONCLUSION # | ||
|
r1728 | Enjoy our software and thank you! | ||