readme.markdown
74 lines
| 2.5 KiB
| text/x-markdown
|
MarkdownLexer
neko259
|
r433 | # INTRO # | ||
This project aims to create centralized forum-like discussion platform with | ||||
anonymity in mind. | ||||
Main repository: https://bitbucket.org/neko259/neboard/ | ||||
neko259
|
r434 | |||
neko259
|
r433 | Site: http://neboard.me/ | ||
Павел Ряполов (nektarin)
|
r2135 | **THIS PROJECT IS DISCONTINUED** | ||
Due to python/django limitations and performance considerations the board was rewritten in Java. See https://bitbucket.org/neko259/newneboard/ | ||||
Some features are not implemented yet in the java version and some were deliberately removed. If you need them, feel free to use the old board. | ||||
Themes from the java project can be migrated to this one at the moment this document is being updated. | ||||
neko259
|
r433 | # INSTALLATION # | ||
Xdevelnet
|
r1535 | 1. Download application and move inside it: | ||
`hg clone https://bitbucket.org/neko259/neboard` | ||||
`cd neboard` | ||||
neko259
|
r1523 | |||
Xdevelnet
|
r1535 | 2. Install all application dependencies: | ||
Some minimal system-wide depenencies: | ||||
neko259
|
r1523 | |||
Xdevelnet
|
r1535 | * python3 | ||
* pip/pip3 | ||||
* jpeg | ||||
Bohdan Horbyeshko
|
r2096 | * zlib | ||
Xdevelnet
|
r1535 | |||
Python dependencies: | ||||
`pip3 install -r requirements.txt` | ||||
You can use virtualenv to speed up the process or avoid conflicts. | ||||
neko259
|
r1523 | |||
Xdevelnet
|
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. | ||||
neko259
|
r1836 | Default database is *sqlite*. If you want to change the database backend, refer to the django documentation for the correct settings. Please note that sqlite accepts only one connection at a time, so you won't be able to run 2 servers or a server and a sync at the same time. | ||
Xdevelnet
|
r1535 | |||
4. Setup SECRET_KEY to a secret value in `neboard/settings.py | ||||
5. Run `./manage.py migrate` to apply all migrations | ||||
neko259
|
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). | ||
Xdevelnet
|
r1535 | 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys | ||
neko259
|
r433 | |||
# RUNNING # | ||||
neko259
|
r1523 | You can run the server using django default embedded webserver by running: | ||
neko259
|
r434 | |||
neko259
|
r433 | ./manage.py runserver <address>:<port> | ||
neko259
|
r434 | |||
neko259
|
r1523 | See django-admin command help for details. | ||
neko259
|
r434 | |||
neko259
|
r433 | Also consider using wsgi or fcgi interfaces on production servers. | ||
neko259
|
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. | ||||
neko259
|
r453 | # UPGRADE # | ||
1. Backup your project data. | ||||
neko259
|
r1155 | 2. Copy the project contents over the old project directory | ||
3. Run migrations by `./manage.py migrate` | ||||
neko259
|
r453 | |||
You can also just clone the mercurial project and pull it to update | ||||
neko259
|
r433 | # CONCLUSION # | ||
neko259
|
r1728 | Enjoy our software and thank you! | ||