matrix/authentication-service
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-07-06 05:42:30 +03:00
Code Activity
Files
e3b51c09faac79d6c900b947029c68defb53056c
authentication-service/docs/usage/installation.md
Quentin Gliech 4d589b8fa1 Add some documentation as an mdBook
2021-09-24 19:10:17 +02:00

1.6 KiB
Raw Blame History

Installation

Requirements

  • A PostgreSQL database
  • Either:

Installing from the source

  1. Get the source 
    git clone https://github.com/matrix-org/matrix-authentication-service.git
cd matrix-authentication-service
  2. Compile the CLI 
    cargo build --release
  3. Grab the built binary 
    cp ./target/release/mas-cli ~/.local/bin # Copy the binary somewhere in $PATH
mas-cli --help # Should display the help message

Running from the Docker image

A Docker image is available here: ghcr.io/matrix-org/matrix-authentication-service:main

docker run --rm ghcr.io/matrix-org/matrix-authentication-service:main --help

mas-cli

USAGE:
    mas-cli [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Print help information
    -V, --version    Print version information

OPTIONS:
    -c, --config <CONFIG>...    Path to the configuration file [default: config.yaml]

SUBCOMMANDS:
    config       Configuration-related commands
    database     Manage the database
    help         Print this message or the help of the given subcommand(s)
    manage       Manage the instance
    server       Runs the web server
    templates    Templates-related commands

Note that when running in a Docker environment

The next step is to generate the configuration file and tweak it to reach the PostgreSQL database.