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