##// END OF EJS Templates
readme: formatting
ergo -
Show More
@@ -1,100 +1,100 b''
1 1 AppEnlight
2 2 -----------
3 3
4 4 Automatic Installation
5 5 ======================
6 6
7 7 Use the ansible scripts in the `automation` repository to build complete instance of application
8 8 You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare.
9 9
10 10 Manual Installation
11 11 ===================
12 12
13 13 To run the app you need to have meet prerequsites:
14 14
15 15 - python 3.5+ (currently 3.6 tested)
16 16 - running elasticsearch (6.6.2 tested)
17 17 - running postgresql (9.5+ required, tested 9.6 and 10.6)
18 18 - running redis
19 19
20 20 Install the app by performing
21 21
22 22 pip install -r requirements.txt
23 23
24 24 python setup.py develop
25 25
26 26 Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
27 27
28 28 For production usage you can do:
29 29
30 30 pip install appenlight
31 31 pip install ae_uptime_ce
32 32
33 33
34 34 After installing the application you need to perform following steps:
35 35
36 36 1. (optional) generate production.ini (or use a copy of development.ini)
37 37
38 appenlight-make-config production.ini
38 appenlight-make-config production.ini
note

why is this here?

39 39
40 40 2. Setup database structure:
41 41
42 appenlight-migratedb -c FILENAME.ini
42 appenlight-migratedb -c FILENAME.ini
43 43
44 44 3. To configure elasticsearch:
45 45
46 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
46 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
47 47
48 48 4. Create base database objects
49 49
50 50 (run this command with help flag to see how to create administrator user)
51 51
52 appenlight-initializedb -c FILENAME.ini
52 appenlight-initializedb -c FILENAME.ini
53 53
54 54 5. Generate static assets
55 55
56 appenlight-static -c FILENAME.ini
56 appenlight-static -c FILENAME.ini
57 57
58 58 Running application
59 59 ===================
60 60
61 61 To run the main app:
62 62
63 63 pserve development.ini
64 64
65 65 To run celery workers:
66 66
67 67 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
68 68
69 69 To run celery beat:
70 70
71 71 celery beat -A appenlight.celery --ini FILENAME.ini
72 72
73 73 To run appenlight's uptime plugin:
74 74
75 75 appenlight-uptime-monitor -c FILENAME.ini
76 76
77 77 Real-time Notifications
78 78 =======================
79 79
80 80 You should also run the `channelstream websocket server for real-time notifications
81 81
82 82 channelstream -i filename.ini
83 83
84 84 Testing
85 85 =======
86 86
87 87 To run test suite:
88 88
89 89 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
90 90
91 91
92 92 Development
93 93 ===========
94 94
95 95 To develop appenlight frontend:
96 96
97 97 cd frontend
98 98 npm install
99 99 grunt watch
100 100
Unmatched/outdated inline comments below
note

Normall comment

note

Ok i see

General Comments 4
Under Review
author

Auto status change to "Under Review"

Under Review
author

Auto status change to "Under Review"

You need to be logged in to leave comments. Login now