Skip to content

PlaceOS/staff-api

Repository files navigation

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

# Host header to use when connecting to PlaceOS endpoints
PLACE_HOST_HEADER=example.place.technology

# Skip SSL verification when connecting to PlaceOS endpoints
SSL_VERIFY_NONE=true

# 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.

About

PlaceOS workplace management API.

Resources

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE.md
Unknown
LICENSE-AUS.html

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

6 watching

Forks

Contributors

Languages