tmp/guard
2021-03-09 15:44:26 +05:30
..
config guard bootstrap 2021-03-09 15:44:26 +05:30
migrations guard bootstrap 2021-03-09 15:44:26 +05:30
src guard bootstrap 2021-03-09 15:44:26 +05:30
.gitignore guard bootstrap 2021-03-09 15:44:26 +05:30
Cargo.toml guard bootstrap 2021-03-09 15:44:26 +05:30
README.md guard bootstrap 2021-03-09 15:44:26 +05:30

NOTE: This is an actix boilerplate repo

  • Uses sqlx so set up database and carryout migrations before cargo run
  • also change placeholder to github username and placeholder-repo to repo name
  • change PLACEHOLDER to app name as mentioned in ./src/settings.rs

placeholder-repo

CI (Linux) codecov AGPL License dependency status

STATUS: ACTIVE DEVELOPMENT (fancy word for unusable)

placeholder-repo is an placeholder-repo 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/placeholder/placeholder-repo
  • Build with Cargo:
$ cd placeholder-repo && cargo build

Configuration:

placeholder-repo is highly configurable. Configuration is applied/merged in the following order:

  1. config/default.toml
  2. environment variables.

To make installation process seamless, placeholder-repo 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
PLACEHOLDER_DATEBASE_PASSWORD Postgres password
PLACEHOLDER_DATEBASE_NAME Postgres database name
PLACEHOLDER_DATEBASE_PORT Postgres port
PLACEHOLDER_DATEBASE_HOSTNAME Postgres hostmane
PLACEHOLDER_DATEBASE_USERNAME Postgres username
PLACEHOLDER_DATEBASE_POOL Postgres database connection pool size
Redis cache:
Name Value
PLACEHOLDER_REDIS_PORT Redis port
PLACEHOLDER_REDIS_HOSTNAME Redis hostmane
Server:
Name Value
PLACEHOLDER_SERVER_PORT (or) PORT** The port on which you want wagon to listen to
PLACEHOLDER_SERVER_IP The IP address on which you want wagon to listen to
PLACEHOLDER_SERVER_STATIC_FILES_DIR Path to directory containing static files