restructure developer's manual

[nominatim.git] / docs / admin / Import.md

diff --git a/docs/admin/Import.md b/docs/admin/Import.md
index bcc33af81e05aee601d8fb88144151f9488c7b04..334c1b758e07326f336ff6d26c56a04c46540f35 100644 (file)
--- a/docs/admin/Import.md
+++ b/docs/admin/Import.md
@@ -187,7 +187,7 @@ enough RAM for PostgreSQL and osm2pgsql as mentioned above. If the system starts
 swapping or you are getting out-of-memory errors, reduce the cache size or
 even consider using a flatnode file.
 
 swapping or you are getting out-of-memory errors, reduce the cache size or
 even consider using a flatnode file.
 

-### Verify import finished
+### Verify the import

 
 Run this script to verify all required tables and indices got created successfully.
 
 
 Run this script to verify all required tables and indices got created successfully.
 


@@ -195,6 +195,30 @@ Run this script to verify all required tables and indices got created successful
 ./utils/check_import_finished.php
 ```
 
 ./utils/check_import_finished.php
 ```
 

+### Setting up the website
+
+Run the following command to set up the configuration file for the website
+`settings/settings-frontend.php`. These settings are used in website/*.php files.
+
+```sh
+./utils/setup.php --setup-website
+```
+!!! Note
+    This step is not necessary if you use `--all` option while setting up the DB.
+
+Now you can try out your installation by running:
+
+```sh
+make serve
+```
+
+This runs a small test server normally used for development. You can use it
+to verify that your installation is working. Go to
+`http://localhost:8088/status.php` and you should see the message `OK`.
+You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`.
+
+To run Nominatim via webservers like Apache or nginx, please read the
+[Deployment chapter](Deployment.md).

 
 ## Tuning the database
 
 
 ## Tuning the database
 


@@ -236,8 +260,6 @@ entire US adds about 10GB to your database.
         wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz
         tar xf tiger2019-nominatim-preprocessed.tar.gz
 
         wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz
         tar xf tiger2019-nominatim-preprocessed.tar.gz
 

-    `data-source/us-tiger/README.md` explains how the data got preprocessed.
-

   2. Import the data into your Nominatim database:
 
         ./utils/setup.php --import-tiger-data
   2. Import the data into your Nominatim database:
 
         ./utils/setup.php --import-tiger-data


@@ -253,3 +275,6 @@ entire US adds about 10GB to your database.
 ```
 
 
 ```
 
 

+See the [developer's guide](../develop/data-sources.md#us-census-tiger) for more
+information on how the data got preprocessed.
+