##// END OF EJS Templates
readme: mention python 3.5+ as a requirement
ergo -
Show More
@@ -1,47 +1,48 b''
1 # appenlight README
1 # appenlight README
2
2
3
3
4 To run the app you need to have meet prerequsites:
4 To run the app you need to have meet prerequsites:
5
5
6 - python 3.5+
6 - running elasticsearch (2.3+ tested)
7 - running elasticsearch (2.3+ tested)
7 - running postgresql (9.5+ required)
8 - running postgresql (9.5+ required)
8 - running redis
9 - running redis
9
10
10 # Setup basics
11 # Setup basics
11
12
12 Set up the basic application database schema:
13 Set up the basic application database schema:
13
14
14 appenlight_initialize_db config.ini
15 appenlight_initialize_db config.ini
15
16
16 Set up basic elasticsearch schema:
17 Set up basic elasticsearch schema:
17
18
18 appenlight-reindex-elasticsearch -c config.ini -t all
19 appenlight-reindex-elasticsearch -c config.ini -t all
19
20
20 Installed the appenlight uptime plugin
21 Installed the appenlight uptime plugin
21
22
22 # Running
23 # Running
23
24
24 To run the application itself:
25 To run the application itself:
25
26
26 pserve --reload development.ini
27 pserve --reload development.ini
27
28
28 To run celery queue processing:
29 To run celery queue processing:
29
30
30 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini=development.ini
31 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini=development.ini
31
32
32 To run celery beats scheduling:
33 To run celery beats scheduling:
33
34
34 celery beat -A appenlight.celery --ini=development.ini
35 celery beat -A appenlight.celery --ini=development.ini
35
36
36 You should also run the `channelstream websocket server for real-time notifications
37 You should also run the `channelstream websocket server for real-time notifications
37
38
38 channelstream -i filename.ini
39 channelstream -i filename.ini
39
40
40 # Testing
41 # Testing
41
42
42 To run test suite:
43 To run test suite:
43
44
44 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
45 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
45
46
46 WARNING!!!
47 WARNING!!!
47 Some tests will insert data into elasticsearch or redis based on testing.ini
48 Some tests will insert data into elasticsearch or redis based on testing.ini
@@ -1,64 +1,65 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 Install the app by performing
13 Install the app by performing
14
14
15 pip install -r requirements.txt
15 pip install -r requirements.txt
16
16
17 python setup.py develop
17 python setup.py develop
18
18
19 To run the app and configure datastore you need to run:
19 To run the app and configure datastore you need to run:
20
20
21 * python 3.5+
21 * elasticsearch (2.2+ tested)
22 * elasticsearch (2.2+ tested)
22 * postgresql 9.5+
23 * postgresql 9.5+
23 * redis 2.8+
24 * redis 2.8+
24
25
25 after installing the application you need to:
26 after installing the application you need to:
26
27
27 1. (optional) generate production.ini (or use a copy of development.ini)
28 1. (optional) generate production.ini (or use a copy of development.ini)
28
29
29 appenlight-make-config production.ini
30 appenlight-make-config production.ini
30
31
31 2. setup database structure:
32 2. setup database structure:
32
33
33 appenlight-migrate-db -c FILENAME.ini
34 appenlight-migrate-db -c FILENAME.ini
34
35
35 3. to configure elasticsearch:
36 3. to configure elasticsearch:
36
37
37 appenlight-reindex-elasticsearch -c FILENAME.ini
38 appenlight-reindex-elasticsearch -c FILENAME.ini
38
39
39 4. create base database objects
40 4. create base database objects
40
41
41 appenlight-initializedb -c FILENAME.ini
42 appenlight-initializedb -c FILENAME.ini
42
43
43 5. generate static assets
44 5. generate static assets
44
45
45 appenlight-static -c FILENAME.ini
46 appenlight-static -c FILENAME.ini
46
47
47 Running application
48 Running application
48 ===================
49 ===================
49
50
50 to run the main app:
51 to run the main app:
51
52
52 pserve development.ini
53 pserve development.ini
53
54
54 to run celery workers:
55 to run celery workers:
55
56
56 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
57 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
57
58
58 to run celery beat:
59 to run celery beat:
59
60
60 celery beat -A appenlight.celery --ini FILENAME.ini
61 celery beat -A appenlight.celery --ini FILENAME.ini
61
62
62 to run appenlight's uptime plugin:
63 to run appenlight's uptime plugin:
63
64
64 appenlight-uptime-monitor -c FILENAME.ini
65 appenlight-uptime-monitor -c FILENAME.ini
General Comments 0
You need to be logged in to leave comments. Login now