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

docs/install.md@873f6fec12f2 (annotated)

docs/install.md

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

author

Matthew Wild <mwild1@gmail.com>

date

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

changeset 168

873f6fec12f2

parent 166

5d39804f108b

permissions

-rw-r--r--

docs/install: Add 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
168 873f6fec12f2 docs/install: Add links Matthew Wild <mwild1@gmail.com> parents: 166 diff changeset	3	### Source code
873f6fec12f2 docs/install: Add links Matthew Wild <mwild1@gmail.com> parents: 166 diff changeset	4
873f6fec12f2 docs/install: Add links Matthew Wild <mwild1@gmail.com> parents: 166 diff changeset	5	The source code can be cloned or downloaded from https://code.matthewwild.co.uk/scansion
873f6fec12f2 docs/install: Add links Matthew Wild <mwild1@gmail.com> parents: 166 diff changeset	6
873f6fec12f2 docs/install: Add links Matthew Wild <mwild1@gmail.com> parents: 166 diff changeset	7	#### Dependencies
166 5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	8
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	9	Scansion requires:
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	10
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	11	- Lua 5.2
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	12	- Verse (a version is bundled by default)
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	13	- LuaExpat
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	14	- LuaCJSON
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	15	- LuaSec
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	16	- LuaSocket
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	17	- LuaFileSystem (optional)
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	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	20
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	21	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	22
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	23	```
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	24	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	25	```
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	26
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	27	### Docker
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	28
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	29	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	30	installed already.
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	31
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	32	First, build the image:
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	```
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	35	docker build -t scansion .
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
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	38	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	39
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	40	```
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	41	docker run -v$PWD/spec/scansion:/scripts scansion
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
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	44	To run it [as a service](usage/service.md):
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	```
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	47	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	48
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	49	```
5d39804f108b docs: Add initial documentation Matthew Wild <mwild1@gmail.com> parents: diff changeset	50