Skip to content
This repository has been archived by the owner on Oct 27, 2022. It is now read-only.

Latest commit

 

History

History
111 lines (64 loc) · 4.29 KB

INSTALL.md

File metadata and controls

111 lines (64 loc) · 4.29 KB
Raw

Set up database

A PostgreSQL database is required.

Previous versions used MariaDB, please read UPGRADE.md.

Create a user and a database, here an example on Linux bash, logged on postgres user:

createuser -Pse USER_NAME_HERE
MY_USER_NAME=user_name_here
MY_DATABASE=database_name_here
createdb --owner=$MY_USER_NAME --encoding=UTF8 $MY_DATABASE

Check with psql -U postgres -c "\l"

Deploy

Deploy keys

Follow GitHub instructions to use read-only deploy keys.

Add to ~/.ssh/config:

Host github.com-wmch-interactive-maps
   Hostname github.com
   IdentityFile=~/.ssh/path_to_private_key

Clone repository

git clone git@github.com-wmch-interactive-maps:synapta/wmch-interactive-maps.git

Pull from repository

git pull

Push

Push is not available with read-only keys.

Node version

To better handle node versions, suggestion is to use nvm.

  • Supported node versions: 16

File (.nvmrc)[.nvmrc] reference the right version to use through nvm use. See nvm documentation for details.

System dependencies

To run screenshot server, you need to install the dependencies listed here.

For example these are the Debian-based basic dependencies at the time of writing:

sudo apt install gconf-service libasound2 libatk1.0-0 libatk-bridge2.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget libgbm-dev

Additional fonts are needed as well to support non-latin fonts on screenshots:

sudo apt-get install fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf

More details on the library manual.

Files and directories

Create screenshots and local directories:

mkdir -p screenshots && mkdir -p local

Screenshots directory will contains preview files for maps, local directory could contain the sqlite database and other development data.

Add localconfig.json

TL;DR: Copy localconfig.example.json to localconfig.json. Change data as needed.

Local settings like database name and authentication data are available in the git ignored localconfig.json in the following formats.

On localconfig.json, set the url to the production url. It will be used to expose the path to the user, something like https://example.org/.

config.json

A global base configuration file is available on config.json.

It contains available map styles based on sources listed on Tile servers page on OpenStreetMap.

Install dependencies

On project root, run:

nvm use && npm ci

Go live

On production, use something like supervisor to keep all services up:

  1. Configure supervisor to handle nvm
  2. Add app.sh and the other scripts to your conf.d/ file as of supervisor-conf.d-maps.example.conf
  3. supervisorctl reread and supervisorctl update

Alternatively, you can use tmux or other similar tools taking care to use always nvm use command.

Troubleshooting

  • Issue: Validation error on a Unique Constraint after a migration, e.g. on histories
  • Fix with: ALTER SEQUENCE histories_id_seq RESTART WITH 20 where 20 is the nextval you need, higher than last value for that sequence.
  • Issue: If on your system you have problem on hanging node installing dependencies (reify...), try downgrade npm
  • Fix with: npm i -g npm@6
  • Issue: Strange placeholder characters appears on screenshots instead of non latin characters
  • Fix with: System dependencies