staff-api v1.0

PlaceOS workplace management API.

PlaceOS Staff API

Build CI Changelog

Service for integrating PlaceOS with the workplace.

Environment

These environment variables are required for configuring an instance of Staff API

SG_ENV=production  # When set to production, the auth token in the request header will be used for auth, instead of static credentials from environment variables

# Database config:
PG_DATABASE_URL=postgresql://user:password@hostname/placeos?max_pool_size=5&max_idle_pool_size=5

# Public key for decrypting and validating JWT tokens
JWT_PUBLIC=base64-public-key  #same one used by PlaceOS rest-api

# Location of PlaceOS API
PLACE_URI=https://example.place.technology

Optional

# Default Timezone
STAFF_TIME_ZONE=Australia/Sydney #default to UTC if not provided

SSL_VERIFY_NONE=true # Whether staff-api should verify the SSL cert that PlaceOS rest-api presents

# Sentry monitoring
SENTRY_DSN=<sentry dsn>

# Logstash log ingest
LOGSTASH_HOST=example.com
LOGSTASH_PORT=12345

# Sentry monitoring
SENTRY_DSN=<sentry dsn>

# Logstash log ingest
LOGSTASH_HOST=example.com
LOGSTASH_PORT=12345

Contributing

See CONTRIBUTING.md.

Repository

staff-api

Owner
Statistic
  • 0
  • 0
  • 10
  • 0
  • 10
  • about 23 hours ago
  • September 15, 2020
License

Other

Links
Synced at

Fri, 03 May 2024 17:27:43 GMT

Languages