• file
• latest
• revisions
• annotate
• diff
• comparison
• raw

docs/install.md@8b322a7eca1e (annotated)

docs/install.md

Fri, 01 Feb 2019 11:35:38 +0000

author

Matthew Wild <mwild1@gmail.com>

date

Fri, 01 Feb 2019 11:35:38 +0000

changeset 167

8b322a7eca1e

parent 166

5d39804f108b

child 168

873f6fec12f2

permissions

-rw-r--r--

README: Add intro and links

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