├── overpass-api-server
    ├── Dockerfile
    ├── build.sh
    └── run.sh
├── overpass-api-httpd
    ├── Dockerfile
    ├── custom_httpd.sh
    ├── build.sh
    └── run.sh
└── README.md


/overpass-api-server/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM alpine AS build
 2 | RUN apk add g++ make expat expat-dev zlib-dev lz4-dev bash
 3 | COPY build.sh ./build.sh
 4 | RUN ./build.sh
 5 | 
 6 | FROM alpine
 7 | RUN apk add libstdc++ expat lz4-dev bash
 8 | COPY run.sh ./run.sh
 9 | COPY --from=build /overpass /overpass
10 | ENV init_from_clone=""
11 | ENV overpass_areas=""
12 | ENTRYPOINT ["./run.sh"]
13 | 


--------------------------------------------------------------------------------
/overpass-api-httpd/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM alpine AS build
 2 | RUN apk add g++ make expat expat-dev zlib-dev lz4-dev bash
 3 | COPY build.sh ./build.sh
 4 | RUN ./build.sh
 5 | 
 6 | FROM httpd:2.4-alpine
 7 | RUN apk add libstdc++ expat lz4-dev bash
 8 | COPY --from=build /overpass /overpass
 9 | RUN mv /overpass/html/* /usr/local/apache2/htdocs/
10 | COPY custom_httpd.sh ./custom_httpd.sh
11 | RUN ./custom_httpd.sh
12 | CMD httpd-foreground -c "LoadModule cgid_module modules/mod_cgid.so"
13 | 
14 | 


--------------------------------------------------------------------------------
/overpass-api-httpd/custom_httpd.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | cat /usr/local/apache2/conf/httpd.conf | awk \
 4 |   '{ print; if ($1 == "ScriptAlias" && !inserted) { print "ScriptAlias /api/ \"/overpass/cgi-bin/\""; inserted = 1; } }' >_
 5 | 
 6 | echo '<Directory "/overpass/cgi-bin">' >>_
 7 | echo '    AllowOverride None' >>_
 8 | echo '    Options None' >>_
 9 | echo '    Require all granted' >>_
10 | echo '    SetEnv OVERPASS_DB_DIR "/overpass/db/"' >>_
11 | echo '</Directory>' >>_
12 | 
13 | mv _ /usr/local/apache2/conf/httpd.conf
14 | 


--------------------------------------------------------------------------------
/overpass-api-httpd/build.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | wget https://dev.overpass-api.de/releases/osm-3s_latest.tar.gz
 4 | gunzip <osm-3s_latest.tar.gz | tar x
 5 | BUILD_DIR=$(gunzip <osm-3s_latest.tar.gz | tar t | head -n 1)
 6 | 
 7 | mkdir -p overpass
 8 | mv "$BUILD_DIR/html" overpass/
 9 | 
10 | pushd "$BUILD_DIR"
11 | ./configure --disable-dependency-tracking --enable-lz4 --prefix="$(pwd)/../overpass"
12 | make -j 2
13 | make install
14 | popd
15 | 
16 | pushd overpass
17 | mkdir -p db
18 | strip bin/*
19 | strip cgi-bin/*
20 | popd
21 | 
22 | 


--------------------------------------------------------------------------------
/overpass-api-server/build.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | wget https://dev.overpass-api.de/releases/osm-3s_latest.tar.gz
 4 | gunzip <osm-3s_latest.tar.gz | tar x
 5 | BUILD_DIR="$(pwd)/$(gunzip <osm-3s_latest.tar.gz | tar t | head -n 1)"
 6 | 
 7 | mkdir -p overpass
 8 | 
 9 | pushd "$BUILD_DIR"
10 | ./configure --disable-dependency-tracking --enable-lz4 --prefix="$(pwd)/../overpass"
11 | make -j 2
12 | make install
13 | cp -pR rules/ "$(pwd)/../overpass/"
14 | popd
15 | 
16 | pushd overpass
17 | mkdir -p db
18 | strip bin/*
19 | strip cgi-bin/*
20 | popd
21 | 
22 | 


--------------------------------------------------------------------------------
/overpass-api-httpd/run.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | PROC_UID=$(id -u)
 4 | DB_UID=$(stat -c '%u' /overpass/db)
 5 | 
 6 | if [[ $PROC_UID -eq 0 ]]; then
 7 |   if [[ $DB_UID -eq 0 ]]; then
 8 |     echo "SECURITY PANIC: the owner of the database directory is root"
 9 |     exit 0
10 |   fi
11 |   adduser --uid $DB_UID --disabled-password overpass
12 |   su overpass ./run.sh &
13 |   RUN_PID=$!
14 | elif [[ $DB_UID -ne $PROC_UID ]]; then
15 |   echo "The user of run.sh does not match the user of the database directory"
16 |   exit 0
17 | else
18 |   cd /overpass
19 |   bin/dispatcher --osm-base --db-dir=db/ &
20 |   export OVERPASS_DB_DIR=/overpass/db/
21 |   sleep 1
22 |   bin/fetch_osc_and_apply.sh https://planet.osm.org/replication/minute &
23 | fi  
24 | 
25 | shutdown()
26 | {
27 |   if [[ $PROC_UID -eq 0 ]]; then
28 |     cd /overpass
29 |     kill $RUN_PID
30 |     wait
31 |   else
32 |     echo "Overpass user stops the dispatcher"
33 |     cd /overpass
34 |     bin/dispatcher --osm-base --terminate
35 |     rm db/*.lock
36 |     exit 0
37 |   fi
38 | };
39 | 
40 | trap shutdown SIGTERM
41 | 
42 | wait
43 | 
44 | 


--------------------------------------------------------------------------------
/overpass-api-server/run.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | PROC_UID=$(id -u)
 4 | DB_UID=$(stat -c '%u' /overpass/db)
 5 | 
 6 | if [[ $PROC_UID -eq 0 ]]; then
 7 |   if [[ $DB_UID -eq 0 ]]; then
 8 |     echo "SECURITY PANIC: the owner of the database directory is root"
 9 |     exit 0
10 |   fi
11 |   adduser --uid $DB_UID --disabled-password overpass
12 |   su overpass ./run.sh &
13 |   RUN_PID=$!
14 | elif [[ $DB_UID -ne $PROC_UID ]]; then
15 |   echo "The user of run.sh does not match the user of the database directory"
16 |   exit 0
17 | else
18 |   cd /overpass
19 |   if [[ ! -f /overpass/db/replicate_id && "${init_from_clone}" == "geo" ]]; then
20 |     bin/download_clone.sh --db-dir=/overpass/db --source=https://dev.overpass-api.de/api_drolbr/ --meta=no
21 |   elif [[ ! -f /overpass/db/replicate_id && "${init_from_clone}" == "meta" ]]; then
22 |     bin/download_clone.sh --db-dir=/overpass/db --source=https://dev.overpass-api.de/api_drolbr/ --meta=yes
23 |   elif [[ ! -f /overpass/db/replicate_id && "${init_from_clone}" == "attic" ]]; then
24 |     bin/download_clone.sh --db-dir=/overpass/db --source=https://dev.overpass-api.de/api_drolbr/ --meta=attic
25 |   fi
26 |   bin/dispatcher --osm-base --db-dir=db/ &
27 |   export OVERPASS_DB_DIR=/overpass/db/
28 |   sleep 1
29 |   bin/fetch_osc_and_apply.sh https://planet.osm.org/replication/minute &
30 |   if [[ "${overpass_areas}" == "yes" ]]; then
31 |     if [[ ! -d db/rules/ ]]; then
32 |       cp -pR rules/ db/
33 |     fi
34 |     bin/dispatcher --areas --db-dir=db/ &
35 |     bin/rules_delta_loop.sh $OVERPASS_DB_DIR &
36 |   fi
37 | fi  
38 | 
39 | shutdown()
40 | {
41 |   if [[ $PROC_UID -eq 0 ]]; then
42 |     cd /overpass
43 |     kill $RUN_PID
44 |     wait
45 |   else
46 |     cd /overpass
47 |     bin/dispatcher --osm-base --terminate
48 |     bin/dispatcher --areas --terminate
49 |     rm -f db/*.lock
50 |     exit 0
51 |   fi
52 | };
53 | 
54 | trap shutdown SIGTERM
55 | 
56 | wait
57 | 
58 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | 
 2 | # Docker Container for the Overpass API
 3 | 
 4 | This is a collection of Docker containers to run the Overpass API ([documentation](https://dev.overpass-api.de/overpass-doc/en/), [source code](https://github.com/drolbr/Overpass-API)),
 5 | written by a maintainer of the Overpass API.
 6 | 
 7 | ## Usage
 8 | 
 9 | To use these containers, build them with
10 | 
11 |     pushd overpass-api-server/
12 |     docker build -t osm3s-server .
13 |     popd
14 |     
15 |     pushd overpass-api-httpd/
16 |     docker build -t osm3s-httpd .
17 |     popd
18 | 
19 | Then, run the server container. If you need to download a copy of the OSM data, then you can do so:
20 | 
21 |     docker run -d --name overpass-server -v $DB_DIR:/overpass/db -e init_from_clone=geo osm3s-server
22 | 
23 | Warning: these are hundreds of gigabyte of data, so it will take some time and need a lot of space in the `$DB_DIR` directory.
24 | To avoid accidential downloads, the download is only started if there is no file `replicate_id` in the `$DB_DIR` directory.
25 | In a populated database, the file indicates the id from which the files have been replicated.
26 | Thus, its absence means that the existing data, if any, is dubious.
27 | 
28 | There are also parameter values to download including the meta data (`meta`) or the full database history (`attic`).
29 | 
30 | If you have already a Overpass database prepopulated, then you can start it directly:
31 | 
32 |     docker run -d --name overpass-server -v $DB_DIR:/overpass/db osm3s-server
33 |     
34 | Areas need some extra computation steps.
35 | Thus they must be activated by setting an environment variable with `-e overpass_areas=yes`.
36 | The setting can be combined with the clone setting.
37 | 
38 | As a next step, run the frontend container with `$DB_DIR` set to your database directory:
39 |     
40 |     docker run -d --name overpass-httpd -p 8080:80 -v $DB_DIR:/overpass/db osm3s-httpd
41 | 
42 | Finally, before offering this service over the open internet,
43 | ensure that you proxy the webserver on port 8080 via HTTPS.
44 | For the moment being, I do not know which configurations for Let's Encrypt or other CAs exist out there,
45 | thus there is no direct support for HTTPS in the container yet.
46 | 


--------------------------------------------------------------------------------