diff options
author | Tatiana Jamison <tjamison@jaguarlandrover.com> | 2016-02-23 16:46:58 -0800 |
---|---|---|
committer | Tatiana Jamison <tjamison@jaguarlandrover.com> | 2016-02-23 16:46:58 -0800 |
commit | 1529f48c8c2e4d98a99b2f3a28cbe01f8be9cc43 (patch) | |
tree | 730190b24e033e13fccddf4f7247da2e69c87c0c | |
parent | ceef6f073b224caddc5e5492d71f85b7ef0a448a (diff) | |
download | rvi_core-1529f48c8c2e4d98a99b2f3a28cbe01f8be9cc43.tar.gz |
[53177] Update installation docs
Add install instructions for Ubuntu 14.04
Add install instructions for Raspbian
Add install instructions for Debian
Update build, readme files to point to install instructions
-rw-r--r-- | BUILD.md | 24 | ||||
-rw-r--r-- | INSTALL_debian.md | 113 | ||||
-rw-r--r-- | INSTALL_raspbian.md | 109 | ||||
-rw-r--r-- | INSTALL_ubuntu.md | 104 | ||||
-rw-r--r-- | README.debian_build | 14 | ||||
-rw-r--r-- | README.md | 12 | ||||
-rw-r--r-- | README_ubuntu_14_04.md | 20 |
7 files changed, 349 insertions, 47 deletions
@@ -13,8 +13,10 @@ Attribution-ShareAlike 4.0 International. # BUILD INSTRUCTIONS FOR RVI # -This document describes the build process for the RVI project on an -Ubuntu 14.04 Linux machine. +This document describes the build process from source for the RVI +project on an Ubuntu 14.04 Linux machine. Packages are also available +for [Ubuntu](INSTALL_ubuntu.md), [Debian](INSTALL_debian.md), +and [Raspbian](INSTALL_raspbian.md). Please see ```README.md``` for a general description of the project and its structure. @@ -54,7 +56,8 @@ Grade Linux repositories where the code resides: sudo apt-get install git -Also ensure that you have the latest BlueZ Linux Bluetooth headers and that g++ is installed on your system: +Also ensure that you have the latest BlueZ Linux Bluetooth headers +and that g++ is installed on your system: sudo apt-get install libbluetooth-dev g++ @@ -62,22 +65,25 @@ Also ensure that you have the latest BlueZ Linux Bluetooth headers and that g++ Install Erlang 18.2, or a later version 18 release: -Tested packages of the latest versions of Erlang can be downloaded from [packages.erlang-solutions.com](https://www.erlang-solutions.com/resources/download.html) +Tested packages of the latest versions of Erlang can be downloaded from +[packages.erlang-solutions.com](https://www.erlang-solutions.com/resources/download.html) Add the following line to your /etc/apt/sources.list deb http://packages.erlang-solutions.com/ubuntu trusty contrib -Update and install erlang +Update and install esl-erlang sudo apt-get update - sudo apt-get install erlang + sudo apt-get install esl-erlang -**If you receive an authentication error** (such as NO_PUBKEY): note the hexadecimal value (e.g., 6D975C4791E7EE5E) and request the key: +**If you receive an authentication error** (such as NO_PUBKEY): +note the hexadecimal value (e.g., 6D975C4791E7EE5E) and request the key: - sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys HEXVALUE + sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys HEX -where HEXVALUE is the hexadecimal value specified in the error. Then rerun the ```update``` and ```install``` commands. +where HEX is the hexadecimal value specified in the error. +Then rerun the ```update``` and ```install``` commands. ## CLONE THE RVI REPOSITORY ## diff --git a/INSTALL_debian.md b/INSTALL_debian.md new file mode 100644 index 0000000..cd8ef9c --- /dev/null +++ b/INSTALL_debian.md @@ -0,0 +1,113 @@ +Copyright (C) 2014-2016, Jaguar Land Rover + +This document is licensed under Creative Commons +Attribution-ShareAlike 4.0 International. + +**Version 0.5.0** + +# INSTALLATION OF RVI (DEBIAN) # + +This document describes the installation process for the RVI project +on a Debian 8 ("jessie") Linux machine. Packages are also available +for [Ubuntu](INSTALL_ubuntu.md) and [Raspbian](INSTALL_raspbian.md). +See ```BUILD.md``` for building from source. + +Please see ```README.md``` for a general description of the project +and its structure. + +Please see ```CONFIGURE.md``` for details on configuring and launching +the system once it has been built. + +The first milestone of the RVI project is the HVAC demo. Please see +```hvac_demo/README.md``` for details on how to setup, launch and +drive the demo. + +# READER ASSUMPTIONS # +In order to build the system, the reader is assumed to be able to: + +1. Have a basic understanding of Linux system operations. +2. Install packages on the system. + +Please note that the configuration process described in +```CONFIGURE.md``` may have additional skill requirements. + +# PREREQUISITES # + +1. The Debian 8 system has the latest updates installed. +2. The user can gain root access to install packages. +3. There is at least 5GB of space availabled for packages and code. + +---- + +# INSTALLATION PROCESS # + +## INSTALL DEPENDENCIES ## + +Install dependent libraries via ```apt-get``` - note you must be root: + + apt-get install python-jsonrpclib + +## INSTALL ESL-ERLANG ## + +Install `esl-erlang` 18.2, or a later version 18 release: + +Tested packages of the latest versions of Erlang can be downloaded from +[packages.erlang-solutions.com](https://www.erlang-solutions.com/resources/download.html) + +Add the following line to your /etc/apt/sources.list + + deb http://packages.erlang-solutions.com/debian jessie contrib + +Update and install `esl-erlang`: + + apt-get update + apt-get install esl-erlang + +**If you receive an authentication error** (such as NO_PUBKEY): note +the hexadecimal value (e.g., 6D975C4791E7EE5E) and request the key: + + apt-key adv --keyserver keyserver.ubuntu.com --recv-keys HEX + +where HEX is the hexadecimal value specified in the error. +Then rerun the ```update``` and ```install``` commands. + +## DOWNLOAD AND INSTALL RVI ## + +Download the RVI package from the remote location: + + wget http://(TODO)/rvi_0.5.0-1_amd64.deb + +Then install RVI via dpkg: + + sudo dpkg -i rvi_0.5.0-1_amd64.deb + +---- + +## TEST THE RVI SYSTEM ## + +To confirm that RVI has started, use `systemctl` as root user: + + systemctl status rvi + +Expected output: + + ● rvi.service - Remote Vehicle Interaction Service + Loaded: loaded (/lib/systemd/system/rvi.service; disabled) + Active: active (running) since Mon 2016-02-22 14:16:27 PST; 15min ago + Process: 1922 ExecStart=/usr/bin/rvi_ctl -c /etc/rvi/rvi.config start (code=exited, status=0/SUCCESS) + Main PID: 1954 (run_erl) + CGroup: /system.slice/rvi.service + ├─1954 run_erl -daemon /tmp/rvi_1922/ /var/log/rvi exec erl -boot /tmp/rvi_1922/rvi/start -sname rvi -config /tmp/rvi_1922/rvi/sys -setcookie rvi_cookie + ├─1955 /usr/lib/erlang/erts-7.2/bin/beam.smp -- -root /usr/lib/erlang -progname erl -- -home /usr/lib/rvi_core -- -boot /tmp/rvi_1922/rvi/start -sname rvi -config /tmp/rvi_1922/rvi/sys -setcookie rvi_cookie + ├─1962 /usr/lib/erlang/erts-7.2/bin/epmd -daemon + ├─1983 /usr/lib/rvi_core/deps/bt/priv/bt + ├─1989 inet_gethost 4 + └─1990 inet_gethost 4 + +## CREATE A RELEASE ## + +The installer configures a release with default (insecure) credentials. + +See ```CONFIGURE.md``` for additional details on configuring and +creating a developer and production release. + diff --git a/INSTALL_raspbian.md b/INSTALL_raspbian.md new file mode 100644 index 0000000..ea8db69 --- /dev/null +++ b/INSTALL_raspbian.md @@ -0,0 +1,109 @@ +Copyright (C) 2014-2016, Jaguar Land Rover + +This document is licensed under Creative Commons +Attribution-ShareAlike 4.0 International. + +**Version 0.5.0** + +# INSTALLATION OF RVI (RASPBIAN) # + +This document describes the installation process for the RVI project +on Raspbian. Packages are also available for +[Ubuntu](INSTALL_ubuntu.md) and [Raspbian](INSTALL_raspbian.md). +See ```BUILD.md``` for building from source. + +Please see ```README.md``` for a general description of the project +and its structure. + +Please see ```CONFIGURE.md``` for details on configuring and launching +the system once it has been built. + +The first milestone of the RVI project is the HVAC demo. Please see +```hvac_demo/README.md``` for details on how to setup, launch and +drive the demo. + +# READER ASSUMPTIONS # +In order to build the system, the reader is assumed to be able to: + +1. Have a basic understanding of Linux system operations. +2. Install packages on the system. + +Please note that the configuration process described in +```CONFIGURE.md``` may have additional skill requirements. + +# PREREQUISITES # + +1. The Raspbian system has the latest updates installed. +2. The user has sudo access to install packages. +3. There is at least 5GB of space availabled for packages and code. + +---- + +# INSTALLATION PROCESS # + +## GET RASPBIAN PACKAGES ## + +Download Erlang and RVI for Raspbian: + + wget (TODO)/erlang-18.2.tar.bz2 + wget (TODO)/rvi_0.5.0-1_armhf.deb + +Also download the install script: + + wget (TODO)/installRVI + +## INSTALL ERLANG AND RVI ## + +Make the install script executable: + + sudo chmod +x installRVI + +Then run the install script: + + ./installRVI + +This does the following: + +1. Extracts the Erlang tarball +2. Installs the required Erlang packages + * `erlang-base` + * `erlang-asnl` + * `erlang-crypto` + * `erlang-eunit` + * `erlang-public key` + * `erlang-ssl` + * `erlang-syntax-tools` +3. Installs other dependencies (`bluez` and `python-jsonrpclib`) +4. Installs `rvi` +5. Starts `rvi` via `systemctl` +6. Checks the status of `rvi` via `systemctl`. + +---- + +## TEST THE RVI SYSTEM ## + +To confirm that RVI has started, use `systemctl` as root user: + + systemctl status rvi + +Expected output: + + ● rvi.service - Remote Vehicle Interaction Service + Loaded: loaded (/lib/systemd/system/rvi.service; disabled) + Active: active (running) since Tue 2016-02-23 18:30:03 UTC; 48ms ago + Process: 6049 ExecStart=/usr/bin/rvi_ctl -c /etc/rvi/rvi.config start (code=exited, status=0/SUCCESS) + Main PID: 6081 (run_erl) + CGroup: /system.slice/rvi.service + ├─6081 run_erl -daemon /tmp/rvi_6049/ /var/log/rvi exec erl -boot /tmp/rvi_6049/rvi/start -sname rvi -config /tmp/rvi_6049/rvi/sys -setcookie rvi_cookie + ├─6084 /usr/lib/erlang/erts-7.2/bin/erlexec -boot /tmp/rvi_6049/rvi/start -sname rvi -config /tmp/rvi_6049/rvi/sys -setcookie rvi_cookie + ├─6093 sh -c "/usr/lib/erlang/erts-7.2/bin/epmd" -daemon + └─6094 /usr/lib/erlang/erts-7.2/bin/epmd -daemon + + +## CREATE A RELEASE ## + +The installer configures a release with default (insecure) credentials. + +See ```CONFIGURE.md``` for additional details on configuring and +creating a developer and production release. + diff --git a/INSTALL_ubuntu.md b/INSTALL_ubuntu.md new file mode 100644 index 0000000..fa4a8f7 --- /dev/null +++ b/INSTALL_ubuntu.md @@ -0,0 +1,104 @@ +Copyright (C) 2014-2016, Jaguar Land Rover + +This document is licensed under Creative Commons +Attribution-ShareAlike 4.0 International. + +**Version 0.5.0** + +# INSTALLATION OF RVI (UBUNTU 14.04 TRUSTY) # + +This document describes the installation process for the RVI project on +an Ubuntu 14.04 Linux machine. Packages are also available for +[Debian](BUILD_debian.md) and [Raspbian](BUILD_raspbian.md). +See [```BUILD.md```](BUILD.md) for building from source. + +Please see [```README.md```](README.md) for a general description of the project +and its structure. + +Please see [```CONFIGURE.md```](CONFIGURE.md) for details on configuring and launching +the system once it has been built. + +The first milestone of the RVI project is the HVAC demo. Please see +```hvac_demo/README.md``` for details on how to setup, launch and +drive the demo. + +# READER ASSUMPTIONS # +In order to build the system, the reader is assumed to be able to: + +1. Have a basic understanding of Linux system operations. +2. Install packages on the system. + +Please note that the configuration process described in +```CONFIGURE.md``` may have additional skill requirements. + +# PREREQUISITES # + +1. The Ubuntu 14.04 system have the latest updates installed. +2. The user can gain root access to install packages. +3. There is at least 5GB of space availabled for packages and code. + +---- + +<div class="pagebreak"></div> + +# INSTALLATION PROCESS # + +## INSTALL DEPENDENCIES ## + +Install dependent libraries via `apt-get`: + + sudo apt-get install python-jsonrpclib + +## INSTALL ESL-ERLANG ## + +Install `esl-erlang` 18.2, or a later version 18 release: + +Tested packages of the latest versions of Erlang can be downloaded from +[packages.erlang-solutions.com](https://www.erlang-solutions.com/resources/download.html) + +Add the following line to your /etc/apt/sources.list + + deb http://packages.erlang-solutions.com/ubuntu trusty contrib + +Update and install esl-erlang + + sudo apt-get update + sudo apt-get install esl-erlang + +**If you receive an authentication error** (such as NO_PUBKEY): +note the hexadecimal value (e.g., 6D975C4791E7EE5E) and request the key: + + sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys HEX + +where HEX is the hexadecimal value specified in the error. +Then rerun the ```update``` and ```install``` commands. + +## DOWNLOAD AND INSTALL RVI ## + +Download the RVI package from the remote location: + + wget http://(TODO)/rvi_0.5.0-1ubuntu1_amd64.deb + +Then install RVI via dpkg: + + sudo dpkg -i rvi_0.5.0-1ubuntu1_amd64.deb + +---- + +## TEST THE RVI SYSTEM ## + +To confirm that RVI has installed successfully, run: + + sudo service rvi status + +Expected output: + + TODO + +## CREATE A RELEASE ## + +The installer configures a release with default (insecure) values. + +See ```CONFIGURE.md``` for details on configuring and creating a +developer and production release that can be launched. + diff --git a/README.debian_build b/README.debian_build deleted file mode 100644 index 8614727..0000000 --- a/README.debian_build +++ /dev/null @@ -1,14 +0,0 @@ -Erlang - -apt-get install devscripts -apt-get install bluez -apt-get install libbluetooth-dev -apt-get install git -apt-get install g++ -apt-get install make -apt-get install python-jsonrpclib -apt-get install libwxgtk3.0-0 -apt-get install dh-systemd - -wget https://packages.erlang-solutions.com/erlang/esl-erlang/FLAVOUR_1_general/esl-erlang_18.2-1~debian~jessie_amd64.deb -dpkg -i esl-erlang_18.2-1~debian~jessie_amd64.deb @@ -1,9 +1,9 @@ -Copyright (C) 2014-2015 Jaguar Land Rover +Copyright (C) 2014-2016 Jaguar Land Rover This document is licensed under Creative Commons Attribution-ShareAlike 4.0 International. -# REMOTE VEHICLE INTERACTION (RVI) 0.4.0 # +# REMOTE VEHICLE INTERACTION (RVI) 0.5.0 # This document gives a brief introduction to the codebase of the RVI project and explains the reasoning behind some of the technical @@ -14,10 +14,14 @@ For a high level description, with an exhaustive master usecase walkthrough, please see the High Level Design document [here](https://wiki.automotivelinux.org/_media/eg-rvi/15-456-poc-rvi-hld_reva.pdf) -Git branch management is JLR OSTCs standard git document -[Git strategy](https://docs.google.com/document/d/1xG86q2o5Y-aSn7m8QARIH8hcTpH_yNMWCLQJD47IP48/edit/) +Git branch management is JLR OSTCs standard git document: +[Git strategy](https://docs.google.com/document/d/1xG86q2o5Y-aSn7m8QARIH8hcTpH_yNMWCLQJD47IP48/edit/) | [Git strategy](https://docs.google.com/document/d/1ko12dTXGeb2-E18SHOzGuC1318hGYSCIq3ADSzFOlGM/edit) +Packages are available for some distributions. See installation +instructions for [Ubuntu](INSTALL_ubuntu.md), [Debian](INSTALL_debian.md), +and [Raspbian](INSTALL_raspbian.md). + For build instructions, please check the build instructions: [Markdown](BUILD.md) | [PDF](doc/pdf/BUILD.pdf) diff --git a/README_ubuntu_14_04.md b/README_ubuntu_14_04.md deleted file mode 100644 index da36e13..0000000 --- a/README_ubuntu_14_04.md +++ /dev/null @@ -1,20 +0,0 @@ -# INSTALL INSTRUCTIONS FOR UBUNTU 14.04 PRECISE - -1. Install dependent libraries -sudo apt-get install python-simplejson python-jsonrpclib libwxgtk2.8-0 - -2. Download esl-erlang 18.2 -wget ttps://packages.erlang-solutions.com/erlang/esl-erlang/FLAVOUR_1_general/esl-erlang_18.2-1~ubuntu~precise_amd64.deb - -3. Install esl-erlang -sudo dpkg -i esl-erlang_18.2-1~ubuntu~precise_amd64.deb - -4. Install RVI -sudo dpkg -i rvi_0.5.0-1ubuntu1_amd64.deb - -5. Setup device keys -Assumes that root key pair is already generated. -doc/rvi_protocol.md - -6. Setup device X.509 Certificates - |