CCCHH/sunders
3
0
Fork 1
forked from kamba4/sunders
Code Issues 4 Pull requests Packages 1 Activity Actions

docs: Replaces on-premise instructions with container instructions

Browse source
This commit is contained in:
Vincent Mahnke 2025-10-11 21:46:54 +02:00 • committed by Vincent Mahnke
commit 9af7ddc4e2
1 changed files with 17 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

121
README.md
View file

@ -22,124 +22,35 @@ Color | Description
A running instance of this project can be visited at [https://sunders.uber.space/](https://sunders.uber.space/).
## Prerequisites
- [Docker](https://www.docker.com)
## Installation
If you like to run Surveillance under Surveillance on your own LAMP or LNMP server follow these steps:
To run Surveillance using docker, decide between development/testing or production deployments:
1. Get the sources
### Development/testing
- Copy the content of **home/sunders/** to your home directory, e.g. to **~/sunders/**.
1. Clone this repository
- Copy the content of **www/sunders/** to your server's www directory, e.g. to **/var/www/sunders/**.
2. Run `docker compose up` and wait for services to start up
2. Set up the database
3. Visit `http://localhost:8080/` in a browser; you should see an interactive OpenStreetMap
- Change to the directory **~/sunders/init_cameras/db/**.
_tbd.: Populate camera data_
- Open the file **createDB.sql** and enter a password for the new database user **camera**.
### Production
- Create the database **camera** by executing the file **createDB.sql**.
1. Close this repository
`mysql -h localhost -u root --password=[mysql root password] < createDB.sql`
2. Hardern security by opening `docker-compose.yml` and modifying `MYSQL_PASSWORD` and `MYSQL_ROOT_PASSWORD`
3. Initialize the database
3. Run `docker compose up` and wait for services to start up
Decide whether you like to start with the surveillance entries of the first planet.osm file from September 12, 2012 or if you like to start with the latest planet.osm file or an extract of an individual country or region.
3. Visit `http://localhost:8080/` in a browser to open the web interface
**Start with the surveillance entries of the first planet.osm file from September 12, 2012**
Pros: You don't have to download the latest +50GB planet.osm file to create a sql import file.
Cons: It could take several days until your database is up-to-date and contains all surveillance entries that have been added between September 12, 2012 and today. Furthermore you start with a data record for the whole planet. Maybe you are only interested in the data of a certain country or region.
- Execute the file **initializeDB_planet_20120912.sql** for database user **camera**.
`mysql camera -h localhost -u camera --password=[camera user password] < initializeDB_planet_20120912.sql`
**Start with the latest planet.osm file or an extract of an individual country or state**
Pros: You start with the latest data records. Furthermore you can choose what country or region you like to map.
Cons: If you like to map the whole planet you have to download the latest +50GB planet.osm file. According to your internet connection this could take a while. At last you have to install the command line Openstreetmap data processor [Osmosis](https://wiki.openstreetmap.org/wiki/Osmosis) on your computer.
- Download the latest osm.bz2 file you like to extract the data from, e.g. from [planet.openstreetmap.org](https://planet.openstreetmap.org/) or from [download.geofabrik.de](http://download.geofabrik.de/). They also offer a MD5 sum to verify the downloaded file.
- Copy the just downloaded osm.bz2 file to the directory **~/sunders/init_cameras/**.
- Open the file **~/sunders/init_cameras/createInitialDataFiles.sh** and enter the name of the osm.bz2 file as **XML_FILE**.
`XML_FILE=[file name].osm.bz2`
- Execute **createInitialDataFiles.sh** to create the files **surveillance.osm** and **initializeDB.sql**.
- Move the new files **surveillance.osm** and **initializeDB.sql** to the directory **~/sunders/init_cameras/db/** and change to that directory.
- Execute the file **initializeDB.sql** for database user **camera**.
`mysql camera -h localhost -u camera --password=[camera user password] < initializeDB.sql`
4. Update the database
- Change to the directory **~/sunders/update_cameras/**.
- Rename the file **config.php.example** to **config.php**.
- Open the file **config.php** and enter the **MYSQL_PASSWD** of the database user **camera**. Furthermore enter the **REPLICATE_URL** that fits to your project, e.g. from [planet.openstreetmap.org](https://planet.openstreetmap.org/replication/) or from [download.openstreetmap.fr](http://download.openstreetmap.fr/replication/). Here are some examples:
`https://planet.openstreetmap.org/replication/minute/`
`http://download.openstreetmap.fr/replication/planet/minute/`
`http://download.openstreetmap.fr/replication/europe/minute/`
`http://download.openstreetmap.fr/replication/europe/netherlands/minute/`
- The update process is based on the sequence number comparison between the current **state.txt** file from the replication server, and the locally stored **lastState.txt**. So if you downloaded a osm.bz2 file, you should modify the **sequenceNumber** in the **lastState.txt** file accordingly.
- Execute the file **update_camera.sh** to import all surveillance entries that have been added between the creation of the osm.bz2 file and today.
5. Schedule automatic database updates
- Add this line to your crontab:
`* * * * * /home/[user]/sunders/update_cameras/update_camera.sh > /dev/null 2>&1`
- Go to the directory **~/sunders/update_cameras/logs** to check if your schedule works. After one minute there should be a new log file.
- Go back to your crontab to change the schedule to the values you prefer, e.g. to `23 * * * *` to run the update at every 23rd minute past every hour.
6. Configure the website
- Change to the directory **/var/www/sunders/**.
- Rename the file **config.php.example** to **config.php**.
- Open the file **config.php** and change the definitions of **DEFAULT_ZOOM**, **DEFAULT_LAT**, and **DEFAULT_LON** to set the initial focus of the map to the location you want. Furthermore you can set the **DEFAULT_LANGUAGE**.
7. Check the website
- Enter the URL of your Surveillance under Surveillance instance (e.g. https://myserver/sunders/) into your browser.
- You should see a map with camera icons now.
8. Optional: Add statistics table to your database
- Go to the directory **~/sunders/init_cameras/db/**.
- Execute the file **addStatistics.sql** for database user **camera**.
`mysql camera -h localhost -u camera --password=[camera user password] < addStatistics.sql`
- Open the file **~/sunders/update_cameras/config.php**. Change the value of **USE_STATISTICS** from **false** to **true** and enter the username of your GeoNames account at **WEBSERVICE_USER**.
`define('USE_STATISTICS', true);`
- Open the file **/var/www/sunders/config.php** and change the value of **USE_STATISTICS** from **false** to **true**.
`define('USE_STATISTICS', true);`
- Schedule automatic statistics updates by adding this new line to your crontab. Enter your preferred schedule values, e.g. `42 * * * *` to run the update at every 42nd minute past every hour.
`42 * * * * /home/[user]/sunders/update_cameras/update_statistics.sh > /dev/null 2>&1`
- Check the statistics by entering the URL of the visualization site (e.g. https://myserver/sunders/stats/) into your browser.
_tbd.: Populate camera data_
## Surveillance nodes