Skip to content

minor update #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
milesstoetzner merged 1 commit into from
Aug 28, 2025
Merged

minor update #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/docs/docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ cd gropius
docker-compose -f docker-compose-testing.yaml up
```

Alternatively, it is possible to execut services on its own using Gradle.
Alternatively, it is possible to execute services on its own using Gradle.
[Modules](./modules) provides an overview of the used commands, requirements and runtime dependencies.
[docker-compose-testing.yaml](https://github.com/ccims/gropius/blob/main/docker-compose-testing.yaml) can be used as a reference for a working set of configuration properties for each service.
4 changes: 2 additions & 2 deletions website/docs/docs/login.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /login

# Login Service

The following doc page uses [the defined terminology](#Terminology)
The following doc page uses [the defined terminology](#terminology)

[NestJS](https://nestjs.com/) service providing authentication and login services for the gropius-backend.

Expand All @@ -26,7 +26,7 @@ A strategy is defined by the following capabilities
Strategies are defined as service classes (which can be part of the main code base or provided by separate modules).

One strategy corresponds to one _type_ of authentication (e.g. GitHub OAuth, OpenID connect). Of this type _"strategy instances"_ ca be created that represent one actual authentication provider (e.g. a specific GitHub Enterprise instance, Microsoft Azure OpenID connect).
Instances can be created at runtime by instanciating one defined strategy and providing all required configuration (e.g. for GitHub OAuth the OAuth Endpoints and client credentials).
Instances can be created at runtime by instantiating one defined strategy and providing all required configuration (e.g. for GitHub OAuth the OAuth Endpoints and client credentials).

Once a user authenticates using a strategy instance, this authentication creates _"login data"_, representing the association of the authenticated gropius-user and the strategy instance. It contains all data required to "recognize" a user on following authentications.
A single login/authentication event for one login data is called a _"active login"_
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ async function createConfig() {
docsPluginId: "rest-docs"
},
{
href: "https://github.com/ccims/gropius-backend",
href: "https://github.com/ccims",
label: "GitHub",
position: "right",
},
Expand Down
Loading