spaceapi/daemonproxy repository overview

⁠SpaceApiDaemon deployment

Work in progress, do not use in production!

First draft of the SpaceApiDaemon, a tool that provides your space with an easy to use, valid, SpaceApi.

Goal is to give more people/systems access to change values in your SpaceApi easily (example: Your new temperature sensor which is hooked to an esp gets his own access token and can update temperature readings etc. by itself).

It will also provide a history for e.g. your opening times.

⁠How to start

1. Install docker⁠ and docker-compose⁠.
2. Change the enviroment variables in the .evn file according to your needs. (Set the SPACEAPIURL to localhost if you gonna use a reverse proxy)
3. Create data and config folder

# mkdir -p /opt/spaceapidaemon/{db,config,certificates}

1. Clone the repo and switch into the project folder.
2. Create the config file⁠

# cp config_example.yaml /opt/spaceapidaemon/config/config.yaml

6a. (reverse proxy / testing) If you're already running a webserver, start it with:

# docker-compose up -d

This will open port 2015 (default caddy port), you have to setup your webserver to reverse proxy to that port (nginx⁠, apache⁠). You have to take care of ssl etc by yourself.

6b. (standalone) If you're not running a webserver use the following command to start:

# docker-compose -f standalone.yml up -d

Caddy will take care of getting and update SSL certificates from Lets Encrypt.

1. Copy your token, e.g. the part between the curly braces showing up in the log, it should looks like this.

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MDE3OTQzNzN9.qOW5dnW-HtXm9GotAOk9EJ2lDj-qTkdt3kL9EAbc3IE

1. Open a browser and open https://yourdomain/edit/⁠, and log-in (Button Authorize). You should at least provide data to basedata, location, state, contact and issue_report_channels.

2. Your SpaceApi is now running at https://yourdomain/api/⁠

3. Profit!

⁠Importing data

You can import your current SpaceApi file by using the /api/importJsonFile route. You can also import your histroy using the data collected by n39⁠, using the /api/importN39History route (please just use it once, otherwise you will be left with duplicated data).

Note: Set your spacename before using the n39 import, it will be used for importing.

⁠Displaying statistics

Add the following to your website

<div id="root"></div>
<script src="https://yourdomain/spaceApiDaemon.js">
</script>
<script>
    window.SpaceApiStatistic(
      document.getElementById('root'), // html element
      { apiUrl: 'https://yourdomain/api' } // configuration object
    );
</script>

There are also a few additional configuration parameters

{
  displayHistory: true, // show history data
  displayHistoryChart: true, // show history chart
  displayFilter: true, // show filter for the history data (by default it shows the last year)
  displayStatus: true, // show current status
  chartGradient: [
    '#D9534E',
    '#D47551',
    '#D09453',
    '#CCB054',
    '#C6C856',
    '#A8C458',
    '#8CC059',
    '#72BC5A',
    '#5CB85C',
  ] // replace charts gradient color with your own (these are just steps, in total the system will generate a hundered different ones)
}