##// END OF EJS Templates
u » bodqhrohro » swineboard
RSS
readme.markdown edited online with Bitbucket
Павел Ряполов (nektarin) -
r2135:b49b6bcd default
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -1,67 +1,74
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 **THIS PROJECT IS DISCONTINUED**
11
12 Due to python/django limitations and performance considerations the board was rewritten in Java. See https://bitbucket.org/neko259/newneboard/
13
14 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.
15 Themes from the java project can be migrated to this one at the moment this document is being updated.
16
10 # INSTALLATION #
17 # INSTALLATION #
11
18
12 1. Download application and move inside it:
19 1. Download application and move inside it:
13
20
14 `hg clone https://bitbucket.org/neko259/neboard`
21 `hg clone https://bitbucket.org/neko259/neboard`
15
22
16 `cd neboard`
23 `cd neboard`
17
24
18 2. Install all application dependencies:
25 2. Install all application dependencies:
19
26
20 Some minimal system-wide depenencies:
27 Some minimal system-wide depenencies:
21
28
22 * python3
29 * python3
23 * pip/pip3
30 * pip/pip3
24 * jpeg
31 * jpeg
25 * zlib
32 * zlib
26
33
27 Python dependencies:
34 Python dependencies:
28
35
29 `pip3 install -r requirements.txt`
36 `pip3 install -r requirements.txt`
30
37
31 You can use virtualenv to speed up the process or avoid conflicts.
38 You can use virtualenv to speed up the process or avoid conflicts.
32
39
33 3. Setup a database in `neboard/settings.py`. You can also change other settings like search engine.
40 3. Setup a database in `neboard/settings.py`. You can also change other settings like search engine.
34
41
35 Depending on configured database and search engine, you need to install corresponding dependencies manually.
42 Depending on configured database and search engine, you need to install corresponding dependencies manually.
36
43
37 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.
44 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.
38
45
39 4. Setup SECRET_KEY to a secret value in `neboard/settings.py
46 4. Setup SECRET_KEY to a secret value in `neboard/settings.py
40 5. Run `./manage.py migrate` to apply all migrations
47 5. Run `./manage.py migrate` to apply all migrations
41 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).
48 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).
42 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys
49 7. If you want to use decetral engine, run `./manage.py generate_keypair` to generate keys
43
50
44 # RUNNING #
51 # RUNNING #
45
52
46 You can run the server using django default embedded webserver by running:
53 You can run the server using django default embedded webserver by running:
47
54
48 ./manage.py runserver <address>:<port>
55 ./manage.py runserver <address>:<port>
49
56
50 See django-admin command help for details.
57 See django-admin command help for details.
51
58
52 Also consider using wsgi or fcgi interfaces on production servers.
59 Also consider using wsgi or fcgi interfaces on production servers.
53
60
54 When running for the first time, you need to setup at least one section tag.
61 When running for the first time, you need to setup at least one section tag.
55 Go to the admin page and manually create one tag with "required" property set.
62 Go to the admin page and manually create one tag with "required" property set.
56
63
57 # UPGRADE #
64 # UPGRADE #
58
65
59 1. Backup your project data.
66 1. Backup your project data.
60 2. Copy the project contents over the old project directory
67 2. Copy the project contents over the old project directory
61 3. Run migrations by `./manage.py migrate`
68 3. Run migrations by `./manage.py migrate`
62
69
63 You can also just clone the mercurial project and pull it to update
70 You can also just clone the mercurial project and pull it to update
64
71
65 # CONCLUSION #
72 # CONCLUSION #
66
73
67 Enjoy our software and thank you!
74 Enjoy our software and thank you!
General Comments 0
You need to be logged in to leave comments. Login now