# Installing SCRATCH-MAP

## Table of Contents
  - [README](../README.md)
  - [UPDATE](./UPDATE.md)
  - [Environment Variables](#environment-variables)
  - [Docker](#docker)
    - [Docker Setup](#docker-setup)
    - [Docker Run](#docker-run)
    - [Docker Compose](#docker-compose)
  - [npm or yarn](#npm-or-yarn)
  - [Run as a Service with pm2](#run-as-a-service-with-pm2)

### Environment Variables
  - `process.env.ADDRESS`
    - (optional) address for app to run on
    - DEFAULT: `0.0.0.0`
  - `process.env.PORT`
    - (optional) port for app to run on
    - DEFAULT: `3000`
  - `process.env.DATA_DIR`
    - (recommended) somewhere outside of app dir for update and container compatibility
    - DEFAULT: `APP_DIR/data/`
  - `process.env.LOG_LEVEL`
    - (optional) log level for console output
    - DEFAULT: `INFO`
    - OPTIONS: `INFO`, `DEBUG`
  - `process.env.ENABLE_SHARE`
    - (optional) enables/disables view-only `/view` routes for maps
    - DEFAULT: `false`
    - OPTIONS: `true`, `false`

### Docker

The commands to create the data directory and set permissions are *nix specific and may need to be changed for your system.

The environment variables passed are examples.

#### Docker Setup

```
mkdir -p /opt/containers/scratch-map/data

chown -R 1000:1000 /opt/containers/scratch-map/data
```

#### Docker Run

```
docker run -d --restart=always \
  --name scratch-map -p 8080:8080 \
  -e PORT=8080 -e DATA_DIR=/my-data-dir \
  -v /opt/containers/scratch-map/data:/my-data-dir \
  ad3m3r5/scratch-map:latest
```

#### Docker Compose

```
cd /opt/containers/scratch-map

wget https://raw.githubusercontent.com/ad3m3r5/scratch-map/refs/heads/main/compose.yaml

docker compose up -d
```

### npm or yarn
- Set ENV vars (see above) somewhere they will persist
- npm
  1) `npm install`
  2) `npm start`
- yarn
  1) `yarn install`
  2) `yarn start`

### Run as a Service with pm2

This varies depending on the OS, however I would recommend checking out [pm2](https://pm2.keymetrics.io/).

Example of pm2 command: `DATA_DIR=/my-data-dir pm2 start server.js --name scratch-map`