GeoHelm/app/latest/installing.html

436 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en" >
<!-- Mirrored from geohelm.docs.acugis.com/en/latest/installing.html by HTTrack Website Copier/3.x [XR&CO'2014], Thu, 13 Jul 2023 23:21:50 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation &mdash; AcuGIS GeoHelm 0.4.3 documentation</title>
<!-- AcuGIS 1 -->
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="../../_/static/javascript/readthedocs-doc-embed.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Layout" href="layout.html" />
<link rel="prev" title="Intro" href="intro.html" />
<!-- RTD Extra Head -->
<link rel="stylesheet" href="../../_/static/css/readthedocs-doc-embed.css" type="text/css" />
<script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.org", "builder": "sphinx", "canonical_url": null, "docroot": "/docs/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-1", "language": "en", "page": "installing", "programming_language": "perl", "project": "geohelm", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_rtd_theme", "user_analytics_code": "", "version": "latest"}</script>
<!--
Using this variable directly instead of using `JSON.parse` is deprecated.
The READTHEDOCS_DATA global variable will be removed in the future.
-->
<script type="text/javascript">
READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML);
</script>
<script type="text/javascript" src="../../_/static/javascript/readthedocs-analytics.js" async="async"></script>
<!-- end RTD <extrahead> -->
</head>
<div id="header" style="position: fixed; height: 70px; padding-bottom: 20px; overflow: hidden; background-color: #28728d; display: block; z-index: 1000; width: 100%;">
<div class="acugis_geosuite" style="color:#fff!important; padding-left:30px; font-size:26px; padding-top: 20px;"><a href="https://geohelm.docs.acugis.com/" style="color:#fff!important; text-decoration:none!important">AcuGIS GeoHelm</a></div>
</div>
</div>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div id="header2"> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation" style="padding-top: 45px;">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Intro</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#check-hostname">Check Hostname</a></li>
<li class="toctree-l2"><a class="reference internal" href="#run-the-installer">Run the Installer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#enable-ssl">Enable SSL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="#removing-the-control-panel">Removing the Control Panel</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="layout.html">Layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="webmin.html">Control Panel</a></li>
<li class="toctree-l1"><a class="reference internal" href="webmin.html#removing-the-control-panel">Removing the Control Panel</a></li>
</ul>
<p class="caption"><span class="caption-text">PostGIS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="components/createdb/index.html">Create Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/postgresql/index.html">PostgreSQL</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/postgis/index.html">PostGIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/pgrouting/index.html">PgRouting</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/shp2pgsql/index.html">shp2pgsql</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/osm2pgsql/index.html">osm2pgsql</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/raster2pgsql/index.html">raster2pgsql</a></li>
</ul>
<p class="caption"><span class="caption-text">GeoServer</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="geoserver/admin/index.html">Access</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/geoservers/index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/tomcat/index.html">Apache Tomcat</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/workspace/index.html">Create a Workspace</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/store/index.html">Create Store</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/layer/index.html">Add Layer</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/shp/index.html">Load ESRI Shapefile</a></li>
<li class="toctree-l1"><a class="reference internal" href="geoserver/styles/index.html">Styles</a></li>
</ul>
<p class="caption"><span class="caption-text">pg_tileserv</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="components/pgtileserv/index.html">pg_tileserv</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/pgfeatureserv/index.html">pg_featureserv</a></li>
</ul>
<p class="caption"><span class="caption-text">Database Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="database/snapshot/index.html">Database Snapshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="database/clone/index.html">Clone Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="database/restore/index.html">Restore Database</a></li>
</ul>
<p class="caption"><span class="caption-text">QGIS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="qgis/home.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="qgis/pgservice.html">pg_service.conf</a></li>
<li class="toctree-l1"><a class="reference internal" href="qgis/qgis.html">Create a QGIS Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="qgis/publish.html">Publish Layers</a></li>
<li class="toctree-l1"><a class="reference internal" href="qgis/style-only.html">Publish Styles Only</a></li>
</ul>
<p class="caption"><span class="caption-text">LeafletJS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apps/choropleth.html">Leaflet Choropleth App</a></li>
<li class="toctree-l1"><a class="reference internal" href="apps/geojson.html">Leaflet GeoJson</a></li>
<li class="toctree-l1"><a class="reference internal" href="apps/php.html">Leaflet and PHP</a></li>
</ul>
<p class="caption"><span class="caption-text">Resources</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="resources/documents.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources/css.html">CSS</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources/security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources/nagios.html">Nagios</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources/support.html">Project Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources/commercial.html">Commercial Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources/license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index-2.html">AcuGIS GeoHelm</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index-2.html" class="icon icon-home"></a> &raquo;</li>
<li>Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/AcuGIS/GeoHelm/blob/master/docs/installing.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Installation is done via the GeoHelm Installer.</p>
<div class="section" id="check-hostname">
<h2>Check Hostname<a class="headerlink" href="#check-hostname" title="Permalink to this headline"></a></h2>
<p>While you can use GeoHelm with only an IP address, if you wish to use SSL, be sure to set the hostname.</p>
<p>You can check using the hostname command</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">root@suite:~# </span>hostname
<span class="go">suite</span>
</pre></div>
</div>
<p>If the full hostname is not set, use hostnamectl to set the full hostname:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">root@suite:~# </span>hostnamectl<span class="w"> </span>set-hostname<span class="w"> </span>suite.domain.com
</pre></div>
</div>
<p>Use the hostname command to verify the full hostname is now set:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">root@suite:~# </span>hostname
<span class="go">suite.domain.com</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If using Rocky Linux, you may need to install wget before running the Installer. You can do using yum -y install wget</p>
</div>
</div>
<div class="section" id="run-the-installer">
<h2>Run the Installer<a class="headerlink" href="#run-the-installer" title="Permalink to this headline"></a></h2>
<p>On a fresh Ubuntu 22 or Rocky Linux 9 installation, as root:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">wget https://raw.githubusercontent.com/AcuGIS/geohelm/master/scripts/geohelm-installer.sh &amp;&amp; chmod +x geohelm-installer.sh &amp;&amp; ./geohelm-installer.sh</span>
</pre></div>
</div>
<p>The above will start the installer</p>
<img alt="_images/Install1.png" src="_images/Install1.png" />
<img alt="_images/spacer10.png" src="_images/spacer10.png" />
<p>Tab to the OK button and hit enter</p>
<img alt="_images/Install2.png" src="_images/Install2.png" />
<img alt="_images/spacer10.png" src="_images/spacer10.png" />
<p>A reminder is displayed to set the hostname. If you have set the hostname, or do not wish to use SSL, hit continue</p>
<img alt="_images/Install3.png" src="_images/Install3.png" />
<img alt="_images/spacer10.png" src="_images/spacer10.png" />
<p>A prompt will ask you if you would like GeoHelm to provision a free SSL certificate using LetsEncrypt</p>
<img alt="_images/Install4.png" src="_images/Install4.png" />
<img alt="_images/spacer10.png" src="_images/spacer10.png" />
<p>The installation progressed is displayed as below.</p>
<img alt="_images/geosuite-installer-screen-5.png" src="_images/geosuite-installer-screen-5.png" />
<img alt="_images/spacer10.png" src="_images/spacer10.png" />
<p>A full installation on Ubuntu takes about 3 to 4 minutes to complete installation.</p>
<p>A full installation with Rocky Linux can take 10-15 minutes due to manual OSM build required.</p>
<p>Upon completion the display will show as below:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Installation is now completed.</span>
<span class="go">Access pg-tileserv at http://YourIP:7800</span>
<span class="go">Access pg-featureserv at http://YourIP:9000</span>
<span class="go">postgres and crunchy pg passwords are saved in /root/auth.txt file</span>
</pre></div>
</div>
<p>The passwords are also stored in the file /root/auth.txt following set up</p>
</div>
<div class="section" id="enable-ssl">
<h2>Enable SSL<a class="headerlink" href="#enable-ssl" title="Permalink to this headline"></a></h2>
<p>If you did not have the GeoHelm installer enable SSL, you can use the script below to issue a certificate and configure Apache, the control panel, and pg_tileserv for SSL.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">wget https://raw.githubusercontent.com/AcuGIS/geohelm/master/scripts/build-ssl.sh &amp;&amp; chmod +x build-ssl.sh &amp;&amp; ./build-ssl</span>
</pre></div>
</div>
<p>After a few moments you should see the success message below:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Successfully received certificate.</span>
<span class="go">Certificate is saved at: /etc/letsencrypt/live/suite.domain.com/fullchain.pem</span>
<span class="go">Key is saved at: /etc/letsencrypt/live/suite.domain.com/privkey.pem</span>
<span class="go">This certificate expires on 2023-09-19.</span>
<span class="go">These files will be updated when the certificate renews.</span>
<span class="go">Certbot has set up a scheduled task to automatically renew this certificate in the background.</span>
<span class="go">Deploying certificate</span>
<span class="go">Successfully deployed certificate for suite.webgis1.com to /etc/apache2/sites-available/000-default-le-ssl.conf</span>
<span class="go">Congratulations! You have successfully enabled HTTPS on https://suite.domain.com</span>
<span class="go">- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</span>
<span class="go">If you like Certbot, please consider supporting our work by:</span>
<span class="go"> * Donating to ISRG / Let&#39;s Encrypt: https://letsencrypt.org/donate</span>
<span class="go"> * Donating to EFF: https://eff.org/donate-le</span>
<span class="go">- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</span>
</pre></div>
</div>
<p>SSL is now enabled for Apache, control panel, pg_tileserv, and pg_featursrv</p>
</div>
<div class="section" id="troubleshooting">
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h2>
<p>GeoHelm creates a log file for each installation process.</p>
<p>The files are located in the /tmp directory (screenshot below).</p>
<p>If installation fails, check the last log file generated to see the cause of the failure.</p>
<img alt="_images/install-log.png" src="_images/install-log.png" />
<img alt="_images/spacer10.png" src="_images/spacer10.png" />
</div>
<div class="section" id="removing-the-control-panel">
<h2>Removing the Control Panel<a class="headerlink" href="#removing-the-control-panel" title="Permalink to this headline"></a></h2>
<p>If you do not wish to use the control panel for any reason, it can be removed using below.</p>
<p>Removing the control panel has no effect on any of the components (PostGIS, GeoServer, etc…)</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">root@suite:~# </span>./etc/webmin/uninstall.sh
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="layout.html" class="btn btn-neutral float-right" title="Layout" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="intro.html" class="btn btn-neutral float-left" title="Intro" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright acugis
<span class="commit">
Revision <code>db2a027e</code>.
</span>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org/">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="index.html">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
<dd><a href="http://geohelm.docs.acugis.com/_/downloads/en/latest/pdf/">pdf</a></dd>
<dd><a href="http://geohelm.docs.acugis.com/_/downloads/en/latest/htmlzip/">html</a></dd>
<dd><a href="http://geohelm.docs.acugis.com/_/downloads/en/latest/epub/">epub</a></dd>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="http://readthedocs.org/projects/geohelm/?fromdocs=geohelm">Project Home</a>
</dd>
<dd>
<a href="http://readthedocs.org/builds/geohelm/?fromdocs=geohelm">Builds</a>
</dd>
</dl>
</div>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
<!-- Mirrored from geohelm.docs.acugis.com/en/latest/installing.html by HTTrack Website Copier/3.x [XR&CO'2014], Thu, 13 Jul 2023 23:21:54 GMT -->
</html>