##// END OF EJS Templates
README: mention getappenlight.com documentation
ergo -
Show More
@@ -1,104 +1,109 b''
1 AppEnlight
1 AppEnlight
2 -----------
2 -----------
3
3
4 Performance, exception, and uptime monitoring for the Web
4 Performance, exception, and uptime monitoring for the Web
5
5
6 ![AppEnlight image](https://raw.githubusercontent.com/AppEnlight/appenlight/gh-pages/static/appenlight.png)
6 ![AppEnlight image](https://raw.githubusercontent.com/AppEnlight/appenlight/gh-pages/static/appenlight.png)
7
7
8 Automatic Installation
8 Automatic Installation
9 ======================
9 ======================
10
10
11 Use the ansible scripts in the `automation` repository to build complete instance of application
11 Use the ansible scripts in the `automation` repository to build complete instance of application
12 You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare.
12 You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare.
13
13
14 Manual Installation
14 Manual Installation
15 ===================
15 ===================
16
16
17 To run the app you need to have meet prerequsites:
17 To run the app you need to have meet prerequsites:
18
18
19 - python 3.5+ (currently 3.6 tested)
19 - python 3.5+ (currently 3.6 tested)
20 - running elasticsearch (6.6.2 tested)
20 - running elasticsearch (6.6.2 tested)
21 - running postgresql (9.5+ required, tested 9.6 and 10.6)
21 - running postgresql (9.5+ required, tested 9.6 and 10.6)
22 - running redis
22 - running redis
23
23
24 Install the app by performing
24 Install the app by performing
25
25
26 pip install -r requirements.txt
26 pip install -r requirements.txt
27
27
28 python setup.py develop
28 python setup.py develop
29
29
30 Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
30 Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
31
31
32 For production usage you can do:
32 For production usage you can do:
33
33
34 pip install appenlight
34 pip install appenlight
35 pip install ae_uptime_ce
35 pip install ae_uptime_ce
36
36
37
37
38 After installing the application you need to perform following steps:
38 After installing the application you need to perform following steps:
39
39
40 1. (optional) generate production.ini (or use a copy of development.ini)
40 1. (optional) generate production.ini (or use a copy of development.ini)
41
41
42 appenlight-make-config production.ini
42 appenlight-make-config production.ini
43
43
44 2. Setup database structure:
44 2. Setup database structure:
45
45
46 appenlight-migratedb -c FILENAME.ini
46 appenlight-migratedb -c FILENAME.ini
47
47
48 3. To configure elasticsearch:
48 3. To configure elasticsearch:
49
49
50 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
50 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
51
51
52 4. Create base database objects
52 4. Create base database objects
53
53
54 (run this command with help flag to see how to create administrator user)
54 (run this command with help flag to see how to create administrator user)
55
55
56 appenlight-initializedb -c FILENAME.ini
56 appenlight-initializedb -c FILENAME.ini
57
57
58 5. Generate static assets
58 5. Generate static assets
59
59
60 appenlight-static -c FILENAME.ini
60 appenlight-static -c FILENAME.ini
61
61
62 Running application
62 Running application
63 ===================
63 ===================
64
64
65 To run the main app:
65 To run the main app:
66
66
67 pserve development.ini
67 pserve development.ini
68
68
69 To run celery workers:
69 To run celery workers:
70
70
71 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
71 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
72
72
73 To run celery beat:
73 To run celery beat:
74
74
75 celery beat -A appenlight.celery --ini FILENAME.ini
75 celery beat -A appenlight.celery --ini FILENAME.ini
76
76
77 To run appenlight's uptime plugin:
77 To run appenlight's uptime plugin:
78
78
79 appenlight-uptime-monitor -c FILENAME.ini
79 appenlight-uptime-monitor -c FILENAME.ini
80
80
81 Real-time Notifications
81 Real-time Notifications
82 =======================
82 =======================
83
83
84 You should also run the `channelstream websocket server for real-time notifications
84 You should also run the `channelstream websocket server for real-time notifications
85
85
86 channelstream -i filename.ini
86 channelstream -i filename.ini
87
87
88 Additional documentation
89 ========================
90
91 Visit https://getappenlight.com for additional server and client documentation.
92
88 Testing
93 Testing
89 =======
94 =======
90
95
91 To run test suite:
96 To run test suite:
92
97
93 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
98 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
94
99
95
100
96 Development
101 Development
97 ===========
102 ===========
98
103
99 To develop appenlight frontend:
104 To develop appenlight frontend:
100
105
101 cd frontend
106 cd frontend
102 npm install
107 npm install
103 grunt watch
108 grunt watch
104
109
General Comments 1
Under Review
author

Auto status change to "Under Review"

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