corrade-group-linguistics – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | office | 1 | [:- Requirements -:] |
2 | |||
3 | * node.js, confirmed working with version 10.15.3 (node -v) and NPM |
||
4 | |||
5 | Two programs will have to be running: Corrade and this program. |
||
6 | |||
7 | Setting up Corrade is wholely documented on the Wizardry and Steamworks Corrade |
||
8 | page. |
||
9 | Node.JS can be installed for each Linux distribution and for Windows from |
||
10 | official sources. |
||
11 | |||
12 | [:- Installing -:] |
||
13 | |||
14 | In the directory containing this document issue the command: |
||
15 | |||
16 | npm install |
||
17 | |||
18 | in order to install dependencies. |
||
19 | |||
20 | Next, copy the file "config.yml.dist" to "config.yml" and edit the file to make |
||
21 | the settings. |
||
22 | |||
23 | [:- Running -:] |
||
24 | |||
25 | For a test run, execute: |
||
26 | |||
27 | node main.js |
||
28 | |||
29 | and follow the console messages. If everything went well, the program will |
||
30 | announce that it has connected to the Corrade MQTT server. |
||
31 | |||
32 | [:- Linux: Running as a Service -:] |
||
33 | |||
34 | Copy the file from "contrib/linux/corrade-group-linguistics.service" to |
||
35 | "/etc/systemd/system/" and edit it to configure parameters. |
||
36 | |||
37 | Set the executable bit on the main file in the download directory: |
||
38 | |||
39 | chmod +x main.js |
||
40 | |||
41 | Issue the command: |
||
42 | |||
43 | systemctl enable corrade-group-linguistics |
||
44 | |||
45 | to enable the service. |
||
46 | |||
47 | Finally, issue: |
||
48 | |||
49 | systemctl start corrade-group-linguistics |
||
50 | |||
51 | to start up the program in the background. |
||
52 | |||
53 | The service will be restarted in case it crashes and will also restart after |
||
54 | reboots. |
||
55 | |||
56 | (⌐■_■) |
||
57 | |||
58 | [:- Licensing and Terms -:] |
||
59 | |||
60 | The standard Corrade dual-license applies to this project. For more information |
||
61 | on the Corrade dual license, please see the Corrade documentation. |