Skip to content

Allow providing login form details via GET params #140

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
aine-etke merged 4 commits into from
Nov 14, 2024
Merged

Allow providing login form details via GET params #140

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c69d06
Allow providing login form details via GET params
beastafk Nov 13, 2024
1604925
add http:// to serverURL if it's only domian name
beastafk Nov 13, 2024
2919a06
Merge branch 'main' into login-details-from-query
aine-etke Nov 14, 2024
61b5c57
update readme
aine-etke Nov 14, 2024
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
Prev Previous commit
update readme
  • Loading branch information
@aine-etke
aine-etke committed Nov 14, 2024
commit 61b5c57a152ede7ab4a9a76e98844daa92d2d198
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This project is built using [react-admin](https://marmelab.com/react-admin/).
* [Changes](#changes)
* [Development](#development)
* [Configuration](#configuration)
* [Prefilling login form](#prefilling-login-form)
* [Restricting available homeserver](#restricting-available-homeserver)
* [Protecting appservice managed users](#protecting-appservice-managed-users)
* [Adding custom menu items](#adding-custom-menu-items)
Expand Down Expand Up @@ -92,6 +93,7 @@ with a proper manifest.json generation on build)
* [Add option to set user's rate limits](https://github.com/etkecc/synapse-admin/pull/125)
* [Support configuration via /.well-known/matrix/client](https://github.com/etkecc/synapse-admin/pull/126)
* [Prevent accidental user overwrites](https://github.com/etkecc/synapse-admin/pull/139)
* [Allow providing login form details via GET params](https://github.com/etkecc/synapse-admin/pull/140)

_the list will be updated as new changes are added_

Expand Down Expand Up @@ -129,6 +131,17 @@ services:
...
```

### Prefilling login form

You can prefill `username` and `homeserver` fields on the login page using GET parameters, example:

```
https://matrix.example.com/synapse-admin/?username=admin&server=matrix.example.com
```

That way `username` and `homeserver` fields will be pre-filled with `admin` and `https://matrix.example.com` respectively.


### Restricting available homeserver

You can restrict the homeserver(s), so that the user can no longer define it himself.
Expand All @@ -137,7 +150,7 @@ Edit `config.json` to restrict either to a single homeserver:

```json
{
"restrictBaseUrl": "https://your-matrixs-erver.example.com"
"restrictBaseUrl": "https://matrix.example.com"
}
```

Expand All @@ -146,7 +159,7 @@ similar for `/.well-known/matrix/client`:
```json
{
"cc.etke.synapse-admin": {
"restrictBaseUrl": "https://your-matrixs-erver.example.com"
"restrictBaseUrl": "https://matrix.example.com"
}
}
```
Expand Down