Show More
@@ -1,50 +1,70 b'' | |||||
1 | # INTRO # |
|
1 | # INTRO # | |
2 |
|
2 | |||
3 | This project aims to create centralized forum-like discussion platform with |
|
3 | This project aims to create centralized forum-like discussion platform with | |
4 | anonymity in mind. |
|
4 | anonymity in mind. | |
5 |
|
5 | |||
6 | Main repository: https://bitbucket.org/neko259/neboard/ |
|
6 | Main repository: https://bitbucket.org/neko259/neboard/ | |
7 |
|
7 | |||
8 | Site: http://neboard.me/ |
|
8 | Site: http://neboard.me/ | |
9 |
|
9 | |||
10 | # INSTALLATION # |
|
10 | # INSTALLATION # | |
11 |
|
11 | |||
12 | 1. Install all dependencies over pip or system-wide |
|
12 | 1. Download application and move inside it: | |
|
13 | ||||
|
14 | `hg clone https://bitbucket.org/neko259/neboard` | |||
|
15 | ||||
|
16 | `cd neboard` | |||
13 |
|
17 | |||
14 | You can use virtualenv to speed up the process. |
|
18 | If you wish to use *decentral* version, change branch to *decentral*: | |
|
19 | ||||
|
20 | `hg up decentral` | |||
15 |
|
21 | |||
16 | Use pip3 install -r requirements.txt |
|
22 | 2. Install all application dependencies: | |
|
23 | ||||
|
24 | Some minimal system-wide depenencies: | |||
17 |
|
25 | |||
18 | Dependencies for the database and search engine need to be installed manually |
|
26 | * python3 | |
19 | when you choose which one to use. |
|
27 | * pip/pip3 | |
|
28 | * jpeg | |||
|
29 | ||||
|
30 | Python dependencies: | |||
|
31 | ||||
|
32 | `pip3 install -r requirements.txt` | |||
|
33 | ||||
|
34 | You can use virtualenv to speed up the process or avoid conflicts. | |||
20 |
|
35 | |||
21 | 2. Setup a database in `neboard/settings.py` |
|
36 | 3. Setup a database in `neboard/settings.py`. You can also change other settings like search engine. | |
22 | 3. Setup SECRET_KEY to a secret value in `neboard/settings.py` |
|
37 | ||
23 | 4. Run `./manage.py migrate` to apply all migrations |
|
38 | Depending on configured database and search engine, you need to install corresponding dependencies manually. | |
24 | 5. Apply config changes to `boards/config/config.ini`. You can see the default settings in `boards/config/default_config.ini` |
|
39 | ||
25 | 6. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys |
|
40 | Default database is *sqlite*, default search engine is *whoosh*. | |
|
41 | ||||
|
42 | 4. Setup SECRET_KEY to a secret value in `neboard/settings.py | |||
|
43 | 5. Run `./manage.py migrate` to apply all migrations | |||
|
44 | 6. Apply config changes to `boards/config/config.ini`. You can see the default settings in `boards/config/default_config.ini` | |||
|
45 | 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys | |||
26 |
|
46 | |||
27 | # RUNNING # |
|
47 | # RUNNING # | |
28 |
|
48 | |||
29 | You can run the server using django default embedded webserver by running: |
|
49 | You can run the server using django default embedded webserver by running: | |
30 |
|
50 | |||
31 | ./manage.py runserver <address>:<port> |
|
51 | ./manage.py runserver <address>:<port> | |
32 |
|
52 | |||
33 | See django-admin command help for details. |
|
53 | See django-admin command help for details. | |
34 |
|
54 | |||
35 | Also consider using wsgi or fcgi interfaces on production servers. |
|
55 | Also consider using wsgi or fcgi interfaces on production servers. | |
36 |
|
56 | |||
37 | When running for the first time, you need to setup at least one section tag. |
|
57 | When running for the first time, you need to setup at least one section tag. | |
38 | Go to the admin page and manually create one tag with "required" property set. |
|
58 | Go to the admin page and manually create one tag with "required" property set. | |
39 |
|
59 | |||
40 | # UPGRADE # |
|
60 | # UPGRADE # | |
41 |
|
61 | |||
42 | 1. Backup your project data. |
|
62 | 1. Backup your project data. | |
43 | 2. Copy the project contents over the old project directory |
|
63 | 2. Copy the project contents over the old project directory | |
44 | 3. Run migrations by `./manage.py migrate` |
|
64 | 3. Run migrations by `./manage.py migrate` | |
45 |
|
65 | |||
46 | You can also just clone the mercurial project and pull it to update |
|
66 | You can also just clone the mercurial project and pull it to update | |
47 |
|
67 | |||
48 | # CONCLUSION # |
|
68 | # CONCLUSION # | |
49 |
|
69 | |||
50 |
Enjoy our software and thank you! |
|
70 | Enjoy our software and thank you! No newline at end of file |
General Comments 0
You need to be logged in to leave comments.
Login now