From c562f66b5e71f4e7ccb73b3e4edd9f456124e334 Mon Sep 17 00:00:00 2001 From: dklimpel <5740567+dklimpel@users.noreply.github.com> Date: Mon, 24 Jul 2023 14:21:43 +0200 Subject: [PATCH] revert changes in README --- README.md | 37 +++++++++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 822e51b99..674498eb5 100644 --- a/README.md +++ b/README.md @@ -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 - -- Or use the [docker image](https://matrix-org.github.io/matrix-authentication-service/usage/installation.html#running-from-the-docker-image) alternatively.