Identity is an identity and access management platform built for the IndieWeb
How to build
- Install Cargo using rustup with:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Clone the repository with:
$ git clone https://github.com/shuttlecraft/identity
- Build with Cargo:
$ cd identity && cargo build
Configuration:
Identity is highly configurable. Configuration is applied/merged in the following order:
config/default.toml
- environment variables.
To make installation process seamless, identity ships with a CLI tool to assist in database migrations.
Setup
Environment variables:
Setting environment variables are optional. The configuration files have all the necessary parameters listed. By setting environment variables, you will be overriding the values set in the configuration files.
Database:
Name | Value |
---|---|
IDENTITY_DATEBASE_PASSWORD |
Postgres password |
IDENTITY_DATEBASE_NAME |
Postgres database name |
IDENTITY_DATEBASE_PORT |
Postgres port |
IDENTITY_DATEBASE_HOSTNAME |
Postgres hostmane |
IDENTITY_DATEBASE_USERNAME |
Postgres username |
IDENTITY_DATEBASE_POOL |
Postgres database connection pool size |
Redis cache:
Name | Value |
---|---|
IDENTITY_REDIS_PORT |
Redis port |
IDENTITY_REDIS_HOSTNAME |
Redis hostmane |
Server:
Name | Value |
---|---|
IDENTITY_SERVER_PORT (or) PORT ** |
The port on which you want wagon to listen to |
IDENTITY_SERVER_IP |
The IP address on which you want wagon to listen to |
IDENTITY_SERVER_STATIC_FILES_DIR |
Path to directory containing static files |
Usage
Using Command Line Interface:
identity
):
Server: (Identity is composed of several subcommands(in devel). To see documentation, run `identity -h':
Identity 0.1
Aravinth Manivannan <realaravinth@batsense.net>
An identity management platform for the dweb
USAGE:
identity [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-c, --config <FILE> path to config file
NOTE: by default, Identity will look for config files in ./config
at the root of the repository.
identity-cli
):
CLI tool (identity-cli
is composed of several subcommands(in devel). To see
documentation, run `identity-cli -h':
Identity 0.1
Aravinth Manivannan <realaravinth@batsense.net>
An identity management platform for the dweb
USAGE:
identity-cli [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-c, --config <FILE> path to config file
NOTE: by default, Identity will look for config files in ./config
at the root of the repository.
Credits:
Logo made by Pixel perfect from Flaticon. Do check them out!