##// END OF EJS Templates
readme: updates
ergo -
Show More
@@ -1,105 +1,104 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+
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 After installing the application you need to perform following steps:
29 29
30 30 1. (optional) generate production.ini (or use a copy of development.ini)
31 31
32 32
33 33 appenlight-make-config production.ini
34 34
35 35 2. Setup database structure:
36 36
37 37
38 38 appenlight-migratedb -c FILENAME.ini
39 39
40 40 3. To configure elasticsearch:
41 41
42 42
43 43 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
44 44
45 45 4. Create base database objects
46 46
47 47 (run this command with help flag to see how to create administrator user)
48 48
49 49
50 50 appenlight-initializedb -c FILENAME.ini
51 51
52 52 5. Generate static assets
53 53
54 54
55 55 appenlight-static -c FILENAME.ini
56 56
57 57 Running application
58 58 ===================
59 59
60 60 To run the main app:
61 61
62 62 pserve development.ini
63 63
64 64 To run celery workers:
65 65
66 66 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
67 67
68 68 To run celery beat:
69 69
70 70 celery beat -A appenlight.celery --ini FILENAME.ini
71 71
72 72 To run appenlight's uptime plugin:
73 73
74 74 appenlight-uptime-monitor -c FILENAME.ini
75 75
76 76 Real-time Notifications
77 77 =======================
78 78
79 79 You should also run the `channelstream websocket server for real-time notifications
80 80
81 81 channelstream -i filename.ini
82 82
83 83 Testing
84 84 =======
85 85
86 86 To run test suite:
87 87
88 88 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
89 89
90 90
91 91 Development
92 92 ===========
93 93
94 94 To develop appenlight frontend:
95 95
96 96 cd frontend
97 97 npm install
98 bower install
99 98 grunt watch
100 99
101 100
102 101 Tagging release
103 102 ===============
104 103
105 104 bumpversion --current-version 1.1.1 minor --verbose --tag --commit --dry-run
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