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