Show More
@@ -1,69 +1,71 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://sourceforge.net/p/swineboard/code/ |
|
6 | Main repository: https://sourceforge.net/p/swineboard/code/ | |
7 |
|
7 | |||
|
8 | Mirror: https://code.rhodecode.com/u/bodqhrohro/swineboard | |||
|
9 | ||||
8 | Site: no known running instances yet |
|
10 | Site: no known running instances yet | |
9 |
|
11 | |||
10 | This is a fork of the Django-based version of Neboard engine (replaced with a less functional and more bloated Java-based https://bitbucket.org/neko259/newneboard/ now). |
|
12 | This is a fork of the Django-based version of Neboard engine (replaced with a less functional and more bloated Java-based https://bitbucket.org/neko259/newneboard/ now). | |
11 |
|
13 | |||
12 | # INSTALLATION # |
|
14 | # INSTALLATION # | |
13 |
|
15 | |||
14 | 1. Download application and move inside it: |
|
16 | 1. Download application and move inside it: | |
15 |
|
17 | |||
16 | `hg clone http://hg.code.sf.net/p/swineboard/code swineboard` |
|
18 | `hg clone http://hg.code.sf.net/p/swineboard/code swineboard` | |
17 |
|
19 | |||
18 | `cd swineboard` |
|
20 | `cd swineboard` | |
19 |
|
21 | |||
20 | 2. Install all application dependencies: |
|
22 | 2. Install all application dependencies: | |
21 |
|
23 | |||
22 | Some minimal system-wide depenencies: |
|
24 | Some minimal system-wide depenencies: | |
23 |
|
25 | |||
24 | * python3 |
|
26 | * python3 | |
25 | * pip/pip3 |
|
27 | * pip/pip3 | |
26 | * jpeg |
|
28 | * jpeg | |
27 | * zlib |
|
29 | * zlib | |
28 |
|
30 | |||
29 | Python dependencies: |
|
31 | Python dependencies: | |
30 |
|
32 | |||
31 | `pip3 install -r requirements.txt` |
|
33 | `pip3 install -r requirements.txt` | |
32 |
|
34 | |||
33 | You can use virtualenv to speed up the process or avoid conflicts. |
|
35 | You can use virtualenv to speed up the process or avoid conflicts. | |
34 |
|
36 | |||
35 | 3. Setup a database in `swineboard/settings.py`. You can also change other settings like search engine. |
|
37 | 3. Setup a database in `swineboard/settings.py`. You can also change other settings like search engine. | |
36 |
|
38 | |||
37 | Depending on configured database and search engine, you need to install corresponding dependencies manually. |
|
39 | Depending on configured database and search engine, you need to install corresponding dependencies manually. | |
38 |
|
40 | |||
39 | 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. |
|
41 | 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. | |
40 |
|
42 | |||
41 | 4. Setup SECRET_KEY to a secret value in `swineboard/settings.py |
|
43 | 4. Setup SECRET_KEY to a secret value in `swineboard/settings.py | |
42 | 5. Run `./manage.py migrate` to apply all migrations |
|
44 | 5. Run `./manage.py migrate` to apply all migrations | |
43 | 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). |
|
45 | 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). | |
44 | 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys |
|
46 | 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys | |
45 |
|
47 | |||
46 | # RUNNING # |
|
48 | # RUNNING # | |
47 |
|
49 | |||
48 | You can run the server using django default embedded webserver by running: |
|
50 | You can run the server using django default embedded webserver by running: | |
49 |
|
51 | |||
50 | ./manage.py runserver <address>:<port> |
|
52 | ./manage.py runserver <address>:<port> | |
51 |
|
53 | |||
52 | See django-admin command help for details. |
|
54 | See django-admin command help for details. | |
53 |
|
55 | |||
54 | Also consider using wsgi or fcgi interfaces on production servers. |
|
56 | Also consider using wsgi or fcgi interfaces on production servers. | |
55 |
|
57 | |||
56 | When running for the first time, you need to setup at least one section tag. |
|
58 | When running for the first time, you need to setup at least one section tag. | |
57 | Go to the admin page and manually create one tag with "required" property set. |
|
59 | Go to the admin page and manually create one tag with "required" property set. | |
58 |
|
60 | |||
59 | # UPGRADE # |
|
61 | # UPGRADE # | |
60 |
|
62 | |||
61 | 1. Backup your project data. |
|
63 | 1. Backup your project data. | |
62 | 2. Copy the project contents over the old project directory |
|
64 | 2. Copy the project contents over the old project directory | |
63 | 3. Run migrations by `./manage.py migrate` |
|
65 | 3. Run migrations by `./manage.py migrate` | |
64 |
|
66 | |||
65 | You can also just clone the mercurial project and pull it to update |
|
67 | You can also just clone the mercurial project and pull it to update | |
66 |
|
68 | |||
67 | # CONCLUSION # |
|
69 | # CONCLUSION # | |
68 |
|
70 | |||
69 | Enjoy our software and thank you! |
|
71 | Enjoy our software and thank you! |
General Comments 0
You need to be logged in to leave comments.
Login now