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