README.md

PixelIt.API

This is the API service for the PixelIt project, this provides the bitmaps for the Pixelit.

---

Installation

Use docker-compose

pixelit_api:
  restart: unless-stopped
  container_name: pixelit_api
  image: ghcr.io/pixelit-project/pixelit.api:latest
  volumes:
    - /etc/localtime:/etc/localtime:ro
  environment:
    PORT: 8080
    TELEMETRY_USER_CHECK: true
    MYSQL_HOST: host
    MYSQL_DATABASE: database
    MYSQL_USER: user
    MYSQL_PASSWORD: password
    GITHUB_TOKEN: token
    API_GLOBAL_LIMIT_WINDOW_MS: 300000
    API_GLOBAL_LIMIT_MAX: 100
    API_TELEMETRY_LIMIT_WINDOW_MS: 900000
    API_TELEMETRY_LIMIT_MAX: 10
    API_SAVEBITMAP_LIMIT_WINDOW_MS: 900000
    API_SAVEBITMAP_LIMIT_MAX: 10
    API_GLOBAL_LIMIT_EXCLUDE: "192.168.0.1, 192.168.2.1, 192.168.3.1, ::1"
    API_TELEMETRY_LIMIT_EXCLUDE: "192.168.0.1, 192.168.2.1, 192.168.3.1, ::1"
    API_SAVEBITMAP_LIMIT_EXCLUDE: "192.168.0.1, 192.168.2.1, 192.168.3.1, ::1"
    SEQ_SERVER: http://seqserver:5341
    SEQ_APIKEY: xxxxxxxxxxxx

Develop

Install dependencies with npm install and run dev server with npn run dev.

Changelog

1.8.7 (2024-10-07)

• (o0shojo0o) add uuid to each request

1.8.6 (2024-10-06)

• (o0shojo0o) change node from 20 to 21
• (o0shojo0o) update dependencies

1.8.5 (2023-11-16)

• (o0shojo0o) Build statistics revised

1.8.3 (2023-11-15)

• (o0shojo0o) Version statistics revised

1.8.1 (2023-11-11)

• (o0shojo0o) small fixes

1.8.0 (2023-11-11)

• (o0shojo0o) only active telemetry users can see statistics
• (o0shojo0o) added ENV param TELEMETRY_USER_CHECK

1.7.2 (2023-11-03)

• (o0shojo0o) small fixes

1.7.1 (2023-11-03)

• (o0shojo0o) added more statistics to endpoint Statistics

1.7.0 (2023-11-03)

• (o0shojo0o) added new api endpoint Statistics

1.6.0 (2023-10-27)

• (o0shojo0o) added buildSection for endpoint Telemetry

1.5.0 (2023-09-26)

• (o0shojo0o) added ENV param API_SAVEBITMAP_LIMIT_EXCLUDE

1.4.2 (2023-09-05)

• (o0shojo0o) fix endpoint SaveBitmap

1.4.1 (2023-09-05)

• (o0shojo0o) small fixes

1.4.0 (2023-09-05)

• (o0shojo0o) added new api endpoint SaveBitmap

1.3.0 (2023-07-27)

• (o0shojo0o) added environment variable API_GLOBAL_LIMIT_EXCLUDE
• (o0shojo0o) added environment variable API_TELEMETRY_LIMIT_EXCLUDE

1.2.1 (2023-07-27)

• (o0shojo0o) fix rate limit key

1.2.0 (2023-07-27)

• (o0shojo0o) added environment variable API_GLOBAL_LIMIT_WINDOW_MS
• (o0shojo0o) added environment variable API_GLOBAL_LIMIT_MAX
• (o0shojo0o) added environment variable API_TELEMETRY_LIMIT_WINDOW_MS
• (o0shojo0o) added environment variable API_TELEMETRY_LIMIT_MAX
• (o0shojo0o) added environment variable API_TELEMETRY_LIMIT_MAX
• (o0shojo0o) enrich log with rate limit data
• (o0shojo0o) added .env file support

1.1.1 (2023-02-14)

• (o0shojo0o) added rate limits

1.1.0 (2022-12-13)

• (o0shojo0o) no prereleases for releases statistics, information, etc. not considered.

1.0.1 (2022-09-05)

• (o0shojo0o) fix id check

1.0.0 (2022-09-05)

• (o0shojo0o) inital commit