Skip to content

v1.5.0
Compare
Choose a tag to compare
@hauke96 hauke96 released this 12 Nov 21:09
· 119 commits to master since this release
v1.5.0
9e4e637
This commit was signed with the committer’s verified signature. The key has expired.
hauke96 Hauke Stieler
GPG key ID: 1C242A9080C2A8F0
Expired
Learn about vigilant mode.

The online version is available at stm.hauke-stieler.de.

Changes in v1.5.0:

For self-hosting & admins: Steps you need to do

There are some things you need to do as hoster/admin of your own STM instance:

  • OAuth adjustment (see also stm.md documentation):
    1. Remove variables STM_OAUTH_CONSUMER_KEY and STM_OAUTH_SECRET from your setup. Only your .env and docker-compose.yml files need to be edited. If you use the docker-compose.yml from this repo, then you only need to adjust your .env file.
    2. Register your application in the OAuth2 section on osm.org to get the client-ID and -secret.
    3. Add the two new OAuth2 variables STM_OAUTH2_CLIENT_ID and STM_OAUTH2_SECRET to .env and docker-compose.yml. If you use the docker-compose.yml from this repo, then you only need to adjust your .env file.
  • Adjust your server JSON config. See the stm.md documentation for details on mandatory config values. Here are some additional notes.
    • A lot of values got working defaults now. Check if you can remove things from your config file to keep it small and simple.
    • Change the OAuth config entries (s. above).
    • Add the new client-auth-redirect-url entry to your server JSON-config. It contains the full URL to which the backend should redirect after successful login on osm.org. For the public instance (s. link above), this entry is "client-auth-redirect-url": "https://stm.hauke-stieler.de/oauth-landing". You probably just need to change the domain.
    • All new config entries (see stm.md for descriptions and default values): client-auth-redirect-url, osm-api-url, db-database, oauth2-client-id, oauth2-secret

Optional adjustments:

  • Take a look at the setup of systemd services. The way they are registered changed (the systemd is not necessary anymore). The services themselves (file .service and .timer files) did not change, so no action here will not break anything.
  • If you use the build.sh script, make sure you can execute the docker buildx-command because the old docker build is deprecated.
  • All config entries can now be configured using environment variables.

Features:

  • Redesign of the login page

Bug fixes:

  • Fixing problem inviting user #188

Internals:

  • Migration to OAuth2 #192
  • Read database host from environment variables #179
  • Numerous dependency updates
  • Allow admins to show arbitrary notices on login-screen #194
  • All server configuration entries are now also configurable via environment variables
Assets 2
Loading