From 5cf6184f6c5986cc07789da69ba662061c16140a Mon Sep 17 00:00:00 2001 From: Oleg Lavrovsky Date: Wed, 4 Dec 2024 13:52:03 +0100 Subject: [PATCH] Deploy and index update --- docs/deploy.md | 15 +++++++++------ docs/index.md | 24 ++++++++++++++---------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/deploy.md b/docs/deploy.md index b633f2c..40bda29 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -71,10 +71,10 @@ The following environment variables can be used to toggle **application features * `DRIBDAT_STYLE` - provide the address to a CSS stylesheet for custom global styles. * `DRIBDAT_STAGE` - provide the address to a YAML configuration for custom global [stages](organiser#stages). * `DRIBDAT_APIKEY` - a secret key for connecting bots with write access to the remote [API](#api). -* `DRIBDAT_ALLOW_LOGINS` - set to False to hide the login, so new users can only log into this server via SSO. +* `DRIBDAT_ALLOW_LOGINS` - set to False to hide the login, so new users can only log into this server via SSO or by email. * `DRIBDAT_NOT_REGISTER` - set to True to hide the registration, so new users can only join this server via SSO or invite. * `DRIBDAT_USER_APPROVE` - set to True so that any new non-SSO accounts are inactive until approved by an admin. -* `DRIBDAT_ALLOW_EVENTS` - set to True to allow regular users to start new events, which admins can edit to make visible on the home page. +* `DRIBDAT_ALLOW_EVENTS` - set to True to allow regular users to start new events, which admins can promote by un-hiding from the home page. * `DRIBDAT_SOCIAL_LINKS` - set to False to hide automatic social network links (Twitter etc.) on the site. ## Statistics @@ -109,20 +109,23 @@ OAuth 2.0 support for **Single Sign-On** (SSO) is currently available using [Fla - `github`- [GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - `slack` - [Slack](https://api.slack.com/authentication/oauth-v2) - `azure` - [Microsoft Azure](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-auth-code-flow) -- `oauth2` - [Generic OAuth 2.0 providers](https://oauth.net/2/) (Zitadel, Auth0, etc.) +- `oauth2` - [Generic OAuth 2.0 providers](https://oauth.net/2/) (Zitadel, Auth0, Keycloak, ..) Register your app with the provider, and set the following variables: * `OAUTH_TYPE` - one of the supported providers (see above) * `OAUTH_ID` - the Client ID of your app. * `OAUTH_SECRET` - the Client Secret of your app. -* `OAUTH_DOMAIN` - Slack subdomain, OAuth/Mattermost/Hitobito domain, or Azure tenant. -* `OAUTH_SCOPE` - (optional) comma-delimited Scope, if not blank (e.g. for Auth0: `email,profile,openid`) +* `OAUTH_DOMAIN` - OAuth/Mattermost/Hitobito domain, Slack subdomain, or Azure tenant. +* `OAUTH_SCOPE` - (optional) comma-delimited Scope, if not the default (`email,profile,openid`) +* `OAUTH_USERINFO` - (optional) location of userinfo endpoint relative to the domain. * `OAUTH_SKIP_LOGIN` - (optional) users should go directly to external login screen. * `OAUTH_LINK_REGISTER` - (optional) a registration link to your SSO platform. * `OAUTH_HELP_REGISTER` - (optional) a short text for the login page. -You may then wish to disable non-SSO logins using `DRIBDAT_ALLOW_LOGINS` and registrations with `DRIBDAT_NOT_REGISTER` - or at least enable moderation of non-SSO accounts with `DRIBDAT_USER_APPROVE` and an SMTP provider for e-mail activation. +You may then wish to disable non-SSO logins using `DRIBDAT_ALLOW_LOGINS` (if an e-mail server is configured, they can still use that), and registrations with `DRIBDAT_NOT_REGISTER` + +E-mail activation or moderation (activation in admin area) of non-SSO accounts can be forced with `DRIBDAT_USER_APPROVE` You can find more advice in the [Troubleshooting](trouble#need-help-setting-up-sso) guide. diff --git a/docs/index.md b/docs/index.md index e7f3430..aae0e56 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,17 +2,21 @@ Driven By Data --- -**Dribdat** (from "driven by data") is an open source web application, -featuring a playful ideation and challenge board to help organize -short sprints, co-creative sessions, hackdays and -[awesome hackathons](https://meta.dribdat.cc/event/2) with batteries included. +
-Screenshot of dribdat +**Dribdat** (from "driven by data") is an open source web application, featuring a playful ideation and challenge board to help organize short sprints, co-creative sessions, hackdays and [awesome hackathons](https://meta.dribdat.cc/event/2) with batteries included. See our [roadmap](https://github.com/orgs/dribdat/projects/8/views/2?pane=issue&itemId=89596986) 🔜 sign up to get invited to beta releases at *[EveryHack.day](https://everyhack.day)* + +
+
-### [🏀 Demo](https://demo.dribdat.cc/event/1) [↓ Download](https://github.com/dribdat/dribdat/releases) [⭐ Star](https://github.com/dribdat/dribdat) [👍 Support](https://opencollective.com/dribdat/contribute) +[🏀 Demo](https://demo.dribdat.cc/event/1) +[⭐ Star](https://github.com/dribdat/dribdat) +[📁 Download](https://github.com/dribdat/dribdat/releases) +[👍 Support](https://opencollective.com/dribdat/contribute) + +Screenshot of dribdat +
-🎉 See [announcement](https://meta.dribdat.cc/project/161) -of our next app and sign up to the alpha at [EveryHack.day](https://everyhack.day) # Purpose @@ -21,12 +25,12 @@ Built around Web-friendly standards like [Schema.org](https://schema.org) and [F Dribdat events typically involve open licenses ([Creative Commons](https://creativecommons.org/licenses/), [Open Data Commons](https://opendatacommons.org/licenses/odbl/), etc.), community-developed templates ([School of Data Pipeline](https://schoolofdata.org/methodology/)), and governance instruments ([Hack Code of Conduct](https://hackcodeofconduct.org/)). This is the official platform of [Opendata.ch - Swiss chapter of Open Knowledge](https://opendata.ch), and has been used to host dozens of events in the Swiss [open data](https://hack.opendata.ch), [open hardware](https://now.makezurich.ch), and [open source](https://hacknight.dinacon.ch) community. -Dribdat strives in itself to be an example of a hackable project that can be adapted to other needs and causes. +Our project started from a [Cookiecutter](https://www.cookiecutter.io/), striving in itself to be an example of a hackable project that can be adapted to other needs and causes. It can be used just as a Python-powered backend to aggregate data from Gitea, GitHub, GitLab and other repositories and fileshares in one place. There is a `Vue.js`-based [Backboard app](https://github.com/dribdat/backboard) and a `Node.js` [Chatbot](https://github.com/dribdat/dridbot) available as alternatives to the default Bootstrap user interface, easily customized with a bit of `CSS`. You can customize the layout and presets in an admin panel, or with `YAML` configuration files. -There is more on this in the [User Guide](usage) and [Whitepaper](whitepaper) 🏀 +There is more on this in the [User Guide](usage) and [Whitepaper](whitepaper).