You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2018/09/26 13:51:36 UTC
[trafficcontrol] 19/46: updated traffic portal installation
instructions
This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
commit 7804c86834e4824a2365316f8fe0af8ae8e8badd
Author: ocket8888 <oc...@gmail.com>
AuthorDate: Thu Sep 13 14:12:04 2018 -0600
updated traffic portal installation instructions
---
docs/source/admin/traffic_ops/using.rst | 3 +-
docs/source/admin/traffic_portal/installation.rst | 47 +++++++++++++++--------
2 files changed, 32 insertions(+), 18 deletions(-)
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index f2f71a6..8352167 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -19,8 +19,9 @@
.. |X| image:: ../../_static/bad.png
.. |clock| image:: ../../_static/clock-black.png
+*******************
Traffic Ops - Using
-%%%%%%%%%%%%%%%%%%%
+*******************
The Traffic Ops Menu
diff --git a/docs/source/admin/traffic_portal/installation.rst b/docs/source/admin/traffic_portal/installation.rst
index 8d0a3ce..c55a4a5 100644
--- a/docs/source/admin/traffic_portal/installation.rst
+++ b/docs/source/admin/traffic_portal/installation.rst
@@ -16,36 +16,49 @@
*****************************
Traffic Portal Administration
*****************************
-The following are requirements to ensure an accurate set up:
+Traffic Portal is only supported on CentOS Linux distributions - version 6.7 or higher (including 7.x). It runs on NodeJS and requires version 6.0 or higher.
-* CentOS 6.7 or 7
-* Node.js 6.0.x or above
-**Installing Traffic Portal**
+Installing Traffic Portal
+=========================
- - Download the Traffic Portal RPM from `Apache Jenkins <https://builds.apache.org/job/trafficcontrol-master-build/>`_ or build the Traffic Portal RPM from source (./pkg -v traffic_portal_build).
- - Copy the Traffic Portal RPM to your server
- - curl --silent --location https://rpm.nodesource.com/setup_6.x | sudo bash -
- - sudo yum install -y nodejs
- - sudo yum install -y <traffic_portal rpm>
+#. Download the Traffic Portal RPM from `Apache Jenkins <https://builds.apache.org/job/trafficcontrol-master-build/>`_ or build the Traffic Portal RPM from source (e.g. by running ``./pkg -v traffic_portal_build`` as the root user or with ``sudo`` from the top level of the source repository).
+#. Copy the Traffic Portal RPM to your server
+#. Install NodeJS. This can be done by building it from source, installing with ``yum install nodejs`` if it happens to be in your available repositories (at version 6.0+), or using the NodeSource setup script like so:
-**Configuring Traffic Portal**
+ .. code-block:: bash
- - update /etc/traffic_portal/conf/config.js (if upgrade, reconcile config.js with config.js.rpmnew and then delete config.js.rpmnew)
- - update /opt/traffic_portal/public/traffic_portal_properties.json (if upgrade, reconcile traffic_portal_properties.json with traffic_portal_properties.json.rpmnew and then delete traffic_portal_properties.json.rpmnew)
- - [OPTIONAL] update /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)
+ curl --silent --location https://rpm.nodesource.com/setup_6.x | sudo bash -
-**Starting Traffic Portal**
+#. Install the Traffic Portal RPM e.g. by running ``yum install path/to/traffic_portal.rpm`` as the root user or with ``sudo``.
- - sudo service traffic_portal start
-**Stopping Traffic Portal**
+Configuring Traffic Portal
+==========================
- - sudo service traffic_portal stop
+- update /etc/traffic_portal/conf/config.js (if upgrade, reconcile config.js with config.js.rpmnew and then delete config.js.rpmnew)
+- update /opt/traffic_portal/public/traffic_portal_properties.json (if upgrade, reconcile traffic_portal_properties.json with traffic_portal_properties.json.rpmnew and then delete traffic_portal_properties.json.rpmnew)
+- [OPTIONAL] update /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)
+Starting Traffic Portal
+=======================
+The Traffic Portal RPM comes with a systemd unit file, so under normal circumstances all that is necessary is to run
+ .. code-block:: bash
+ systemctl start traffic_portal
+as the root user or with ``sudo``.
+Stopping Traffic Portal
+=======================
+
+If Traffic Portal was started using ``systemctl``, simply run
+
+ .. code-block:: bash
+
+ systemctl stop traffic_portal
+
+as the root user, or with ``sudo``.