comparison: docs/install.md
docs/install.md
- changeset 166
- 5d39804f108b
- child 168
- 873f6fec12f2
equal
deleted
inserted
replaced
| 165:92e1733243d5 | 166:5d39804f108b |
|---|---|
| 1 ## Installation and setup | |
| 2 | |
| 3 ### Requirements | |
| 4 | |
| 5 Scansion requires: | |
| 6 | |
| 7 - Lua 5.2 | |
| 8 - Verse (a version is bundled by default) | |
| 9 - LuaExpat | |
| 10 - LuaCJSON | |
| 11 - LuaSec | |
| 12 - LuaSocket | |
| 13 - LuaFileSystem (optional) | |
| 14 | |
| 15 If these are present, a simple 'make' and 'sudo make install' should suffice to install scansion to `/usr/local/bin/`. | |
| 16 | |
| 17 On Debian and Ubuntu, these can be installed with the following command: | |
| 18 | |
| 19 ``` | |
| 20 apt install lua5.2 lua-expat lua-cjson lua-sec lua-socket lua-filesystem | |
| 21 ``` | |
| 22 | |
| 23 ### Docker | |
| 24 | |
| 25 A Dockerfile is also provided, to allow you to build and run scansion inside a clean environment with all dependencies | |
| 26 installed already. | |
| 27 | |
| 28 First, build the image: | |
| 29 | |
| 30 ``` | |
| 31 docker build -t scansion . | |
| 32 ``` | |
| 33 | |
| 34 To run it with a directory of test scripts in ./spec/scansion: | |
| 35 | |
| 36 ``` | |
| 37 docker run -v$PWD/spec/scansion:/scripts scansion | |
| 38 ``` | |
| 39 | |
| 40 To run it [as a service](usage/service.md): | |
| 41 | |
| 42 ``` | |
| 43 docker run -p 8007:8007 -v$PWD/spec/scansion:/scripts scansion --serve | |
| 44 | |
| 45 ``` | |
| 46 |
