AcuGIS
/
Nominatim-Server
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Nominatim-Server/app/latest/installation.html

363 lines
15 KiB
HTML
Raw Normal View History

Commit
2024-01-27 22:16:08 +00:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<!-- Mirrored from opennamesearch.docs.acugis.com/en/latest/installation.html by HTTrack Website Copier/3.x [XR&CO'2014], Sat, 15 Jul 2023 21:59:00 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 and Usage &mdash; OpenNameSearch 1.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Enable SSL" href="ssl.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": "installation", "programming_language": "words", "project": "opennamesearch", "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>
<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 class="wy-side-nav-search" >
<a href="index-2.html" class="icon icon-home"> OpenNameSearch
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="https://opennamesearch.docs.acugis.com/en/latest/search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<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 and Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#running-the-script">Running the Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="#welcome-page">Welcome Page</a></li>
<li class="toctree-l2"><a class="reference internal" href="#loading-and-reloading-pbfs">Loading and Reloading PBFs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#enable-automatic-updates">Enable Automatic Updates</a></li>
<li class="toctree-l2"><a class="reference internal" href="#credits">Credits</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contribute">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="#support">Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ssl.html">Enable SSL</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">OpenNameSearch</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">Docs</a> &raquo;</li>
<li>Installation and Usage</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/AcuGIS/OpenNameSearch/blob/master/docs/installation.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-and-usage">
<h1>Installation and Usage<a class="headerlink" href="#installation-and-usage" title="Permalink to this headline"></a></h1>
<p>This script is for building a basic Nominatim server with OpenStreetMap data.</p>
<p>Only for use on a clean Ubuntu 22!</p>
<div class="section" id="running-the-script">
<h2>Running the Script<a class="headerlink" href="#running-the-script" title="Permalink to this headline"></a></h2>
<p>Step 1: Get the OpenNameSearch.sh script from GitHub:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">raw</span><span class="o">.</span><span class="n">githubusercontent</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">AcuGIS</span><span class="o">/</span><span class="n">OpenNameSearch</span><span class="o">/</span><span class="n">master</span><span class="o">/</span><span class="n">OpenNameSearch</span><span class="o">.</span><span class="n">sh</span>
</pre></div>
</div>
<p>Step 2: Make it executable:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">chmod</span> <span class="mi">755</span> <span class="n">OpenNameSearch</span><span class="o">.</span><span class="n">sh</span>
</pre></div>
</div>
<p>Step 3: Run the script:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">OpenNameSearch</span> <span class="n">pbf_url</span>
</pre></div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>Load Andorra data (one of the smallest data sets):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">OpenNameSearch</span><span class="o">.</span><span class="n">sh</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">download</span><span class="o">.</span><span class="n">geofabrik</span><span class="o">.</span><span class="n">de</span><span class="o">/</span><span class="n">europe</span><span class="o">/</span><span class="n">andorra</span><span class="o">-</span><span class="n">latest</span><span class="o">.</span><span class="n">osm</span><span class="o">.</span><span class="n">pbf</span>
</pre></div>
</div>
</div>
<div class="section" id="welcome-page">
<h2>Welcome Page<a class="headerlink" href="#welcome-page" title="Permalink to this headline"></a></h2>
<p>Once installation completes, navigate to the IP or hostname on your server.</p>
<p>You should see a page as below:</p>
<img alt="_images/OpenNameSearch-Main.png" src="_images/OpenNameSearch-Main.png" />
<p>Click the Search function (or go to domain.com/search.html)</p>
<p>You should see a page as below:</p>
<img alt="_images/OpenNameSearch-Search.png" src="_images/OpenNameSearch-Search.png" />
<p>To test functionality, enter below into the Search box:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">AD500</span> <span class="n">Andorra</span> <span class="n">la</span> <span class="n">Vella</span><span class="p">,</span> <span class="n">Andorra</span>
</pre></div>
</div>
<p>Confirm that results are returned</p>
<img alt="_images/Search-Results.png" src="_images/Search-Results.png" />
</div>
<div class="section" id="loading-and-reloading-pbfs">
<h2>Loading and Reloading PBFs<a class="headerlink" href="#loading-and-reloading-pbfs" title="Permalink to this headline"></a></h2>
<p>You can use our reload-OpenNameSearch.sh script via GitHUB script.</p>
<p>Usage is:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">reload</span><span class="o">-</span><span class="n">OpenNameSearch</span><span class="o">.</span><span class="n">sh</span> <span class="p">[</span><span class="n">PBF_URL1</span><span class="p">]</span> <span class="p">[</span><span class="n">PBF_URL2</span><span class="p">]</span> <span class="o">...</span>
</pre></div>
</div>
</div>
<div class="section" id="enable-automatic-updates">
<h2>Enable Automatic Updates<a class="headerlink" href="#enable-automatic-updates" title="Permalink to this headline"></a></h2>
<p>The script creates an updater service. In order to enable updates:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">chmod</span> <span class="o">+</span><span class="n">x</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">nominatim_updater</span>
</pre></div>
</div>
</div>
<div class="section" id="credits">
<h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="https://www.acugis.com/">https://www.acugis.com</a></p>
<p><a class="reference external" href="https://citedcorp.com/">https://citedcorp.com</a></p>
</div>
<div class="section" id="contribute">
<h2>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Issue Tracker: github.com/AcuGIS/OpenNameSearch/issues</li>
<li>Source Code: github.com/AcuGIS/OpenNameSearch</li>
</ul>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline"></a></h2>
<p>If you are having issues, please let us know.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<p>The project is licensed under the BSD license.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="ssl.html" class="btn btn-neutral float-right" title="Enable SSL" 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 2020, Cited, Inc.
<span class="commit">
Revision <code>53d05419</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://opennamesearch.docs.acugis.com/_/downloads/en/latest/pdf/">pdf</a></dd>
<dd><a href="http://opennamesearch.docs.acugis.com/_/downloads/en/latest/htmlzip/">html</a></dd>
<dd><a href="http://opennamesearch.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/opennamesearch/?fromdocs=opennamesearch">Project Home</a>
</dd>
<dd>
<a href="http://readthedocs.org/builds/opennamesearch/?fromdocs=opennamesearch">Builds</a>
</dd>
</dl>
<hr/>
Free document hosting provided by <a href="http://www.readthedocs.org/">Read the Docs</a>.
</div>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
<!-- Mirrored from opennamesearch.docs.acugis.com/en/latest/installation.html by HTTrack Website Copier/3.x [XR&CO'2014], Sat, 15 Jul 2023 21:59:01 GMT -->
</html>