##// END OF EJS Templates
appenlight
RSS

Clone from https://github.com/Appenlight/appenlight.git

readme: updated readme
ergo -
Show More
Show file before | Show file after | Hide comments
@@ -1,97 +1,99 b''
1 AppEnlight
1 AppEnlight
2 -----------
2 -----------
3
3
4 Automatic Installation
4 Automatic Installation
5 ======================
5 ======================
6
6
7 Use the ansible scripts in the `/automation` directory to build complete instance of application
7 Use the ansible scripts in the `/automation` directory to build complete instance of application
8 You can also use `packer` files in `/automation/packer` to create whole VM's for KVM and VMWare.
8 You can also use `packer` files in `/automation/packer` to create whole VM's for KVM and VMWare.
9
9
10 Manual Installation
10 Manual Installation
11 ===================
11 ===================
12
12
13 To run the app you need to have meet prerequsites:
13 To run the app you need to have meet prerequsites:
14
14
15 - python 3.5+
15 - python 3.5+
16 - running elasticsearch (2.3+ tested)
16 - running elasticsearch (2.3+ tested)
17 - running postgresql (9.5+ required)
17 - running postgresql (9.5+ required)
18 - running redis
18 - running redis
19
19
20 Install the app by performing
20 Install the app by performing
21
21
22 pip install -r requirements.txt
22 pip install -r requirements.txt
23
23
24 python setup.py develop
24 python setup.py develop
25
25
26 Install the appenlight uptime plugin (`ae_uptime_ce` package).
26 Install the appenlight uptime plugin (`ae_uptime_ce` package).
27
27
28 After installing the application you need to perform following steps:
28 After installing the application you need to perform following steps:
29
29
30 1. (optional) generate production.ini (or use a copy of development.ini)
30 1. (optional) generate production.ini (or use a copy of development.ini)
31
31
32
32
33 appenlight-make-config production.ini
33 appenlight-make-config production.ini
34
34
35 2. Setup database structure:
35 2. Setup database structure:
36
36
37
37
38 appenlight-migrate-db -c FILENAME.ini
38 appenlight-migratedb -c FILENAME.ini
39
39
40 3. To configure elasticsearch:
40 3. To configure elasticsearch:
41
41
42
42
43 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
43 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
44
44
45 4. Create base database objects
45 4. Create base database objects
46
47 (run this command with help flag to see how to create administrator user)
46
48
47
49
48 appenlight-initializedb -c FILENAME.ini
50 appenlight-initializedb -c FILENAME.ini
49
51
50 5. Generate static assets
52 5. Generate static assets
51
53
52
54
53 appenlight-static -c FILENAME.ini
55 appenlight-static -c FILENAME.ini
54
56
55 Running application
57 Running application
56 ===================
58 ===================
57
59
58 To run the main app:
60 To run the main app:
59
61
60 pserve development.ini
62 pserve development.ini
61
63
62 To run celery workers:
64 To run celery workers:
63
65
64 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
66 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
65
67
66 To run celery beat:
68 To run celery beat:
67
69
68 celery beat -A appenlight.celery --ini FILENAME.ini
70 celery beat -A appenlight.celery --ini FILENAME.ini
69
71
70 To run appenlight's uptime plugin:
72 To run appenlight's uptime plugin:
71
73
72 appenlight-uptime-monitor -c FILENAME.ini
74 appenlight-uptime-monitor -c FILENAME.ini
73
75
74 Real-time Notifications
76 Real-time Notifications
75 =======================
77 =======================
76
78
77 You should also run the `channelstream websocket server for real-time notifications
79 You should also run the `channelstream websocket server for real-time notifications
78
80
79 channelstream -i filename.ini
81 channelstream -i filename.ini
80
82
81 Testing
83 Testing
82 =======
84 =======
83
85
84 To run test suite:
86 To run test suite:
85
87
86 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
88 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
87
89
88
90
89 Development
91 Development
90 ===========
92 ===========
91
93
92 To develop appenlight frontend:
94 To develop appenlight frontend:
93
95
94 cd frontend
96 cd frontend
95 npm install
97 npm install
96 bower install
98 bower install
97 grunt watch
99 grunt watch
General Comments 0
You need to be logged in to leave comments. Login now