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