afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

added section on install page about using install.sh

Browse source
This commit is contained in:
Blake Harnden 2020-04-09 21:42:04 -07:00
parent 36b3243a4b
commit 73a96ffcf5
1 changed files with 26 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/install.md
View file

@ -21,8 +21,8 @@ technology that CORE currently uses is Linux network namespaces.
Ubuntu and CentOS Linux are the recommended distributions for running CORE. However, these distributions are
not strictly required. CORE will likely work on other flavors of Linux as well, assuming dependencies are met.
**NOTE: CORE Services determine what run on each node. You may require other software packages depending on the
services you wish to use. For example, the HTTP service will require the apache2 package.**
> **NOTE:** CORE Services determine what run on each node. You may require other software packages depending on the
services you wish to use. For example, the HTTP service will require the apache2 package.
## Installed Files
@ -43,6 +43,30 @@ Install Path | Description
/etc/init.d/core-daemon|SysV startup script for daemon
/usr/lib/systemd/system/core-daemon.service|Systemd startup script for daemon
## Automated Install
There is a helper script in the root of the repository that can help automate
the CORE installation. Some steps require commands be ran as sudo and you
will be prompted for a password. This should work on Ubuntu/CentOS and will
install system dependencies, python dependencies, and CORE. This will target
system installations of python 3.6.
```shell
git clone https://github.com/coreemu/core.git
cd core
./install.sh
```
You can target newer system python versions using the **-v** flag. Assuming
these versions are actually available on your system.
```shell
# ubuntu 3.7
./install.sh -v 3.7
# centos 3.7
./install.sh -v 37
```
## Pre-Req Installing Python
Python 3.6 is the minimum required python version. Newer versions can be used if available.