letro/letro-authentication-service
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

revert changes in README

Browse Source
This commit is contained in:
dklimpel
2023-07-24 14:21:43 +02:00
committed by Quentin Gliech
parent 5f6c608567
commit c562f66b5e
1 changed files with 27 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -7,14 +7,31 @@ See the [Documentation](https://matrix-org.github.io/matrix-authentication-servi
## Running
- [Observe and install requirements](https://matrix-org.github.io/matrix-authentication-service/usage/installation.html#requirements)
- [Install Matrix Authentication Service](https://matrix-org.github.io/matrix-authentication-service/usage/installation.html#installing-from-the-source)
- [Generate the sample config](https://matrix-org.github.io/matrix-authentication-service/usage/configuration.html)
- [Provide the database](https://matrix-org.github.io/matrix-authentication-service/usage/installation.html#database)
- [Customize your minimal configuration](https://matrix-org.github.io/matrix-authentication-service/usage/configuration.html#minimal-configuration)
- `database.uri`
- [Run the database migrations](https://matrix-org.github.io/matrix-authentication-service/usage/usage.html#running)
- [Run the server](https://matrix-org.github.io/matrix-authentication-service/usage/usage.html#running)
- [Install Rust and Cargo](https://www.rust-lang.org/learn/get-started)
- [Install Node.js and npm](https://nodejs.org/)
- [Install Open Policy Agent](https://www.openpolicyagent.org/docs/latest/#1-download-opa)
- Clone this repository
- Build the frontend
```sh
cd frontend
npm ci
npm run build
cd ..
```
- Build the Open Policy Agent policies
```sh
cd policies
make
# OR, if you don't have `opa` installed and want to build through the OPA docker image
make DOCKER=1
cd ..
```
- Generate the sample config via `cargo run -- config generate > config.yaml`
- Run a PostgreSQL database locally
```sh
docker run -p 5432:5432 -e 'POSTGRES_USER=postgres' -e 'POSTGRES_PASSWORD=postgres' -e 'POSTGRES_DATABASE=postgres' postgres
```
- Update the database URI in `config.yaml` to `postgresql://postgres:postgres@localhost/postgres`
- Run the database migrations via `cargo run -- database migrate`
- Run the server via `cargo run -- server -c config.yaml`
- Go to <http://localhost:8080/>
- Or use the [docker image](https://matrix-org.github.io/matrix-authentication-service/usage/installation.html#running-from-the-docker-image) alternatively.