Skip to content

Commit

Permalink
add altruist env variable in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
blade committed Mar 30, 2024
1 parent d105b1a commit 8f16be1
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/quick-onboarding-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,20 @@ Application stakes in Morse are permissioned, therefore you must receive applica
## 2. Create Encryption Password
Create an encryption password for your app stake keys. This password will be used to encrypt/decrypt your app-stake private keys stored in a Postgres database. It can be any combination of plaintext, symbols, letters, etc.

## 3. Configure Environment Variables
## 3. Configure Global Configuration Variables
Fill out the `.env` variables for the gateway server. This can be done by injecting environment variables directly or using a `.env` file.

### Env Variables Description
| Variable Name | Description | Example Value |
|------------------------------------|----------------------------------------|---------------------------------------------------------------------------------------------------|
| `POKT_RPC_FULL_HOST` | Used for dispatching sessions | `https://pokt-testnet-rpc.nodies.org` (a complimentary testnet dispatcher URL provided by Nodies) |
| `HTTP_SERVER_PORT` | Gateway server port | `8080` |
| `POKT_RPC_TIMEOUT` | Max response time for a Pokt node | `10s` |
| `ENVIRONMENT_STAGE` | Log verbosity | `development`, `production` |
| `SESSION_CACHE_TTL` | Duration for sessions to stay in cache | `75m` |
| `POKT_APPLICATIONS_ENCRYPTION_KEY` | User-generated encryption key | `a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` |
| `DB_CONNECTION_URL` | PostgreSQL Database connection URL | `postgres://user:password@localhost:5432/postgres` |
| Variable Name | Description | Example Value |
|------------------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------------------|
| `POKT_RPC_FULL_HOST` | Used for dispatching sessions | `https://pokt-testnet-rpc.nodies.org` (a complimentary testnet dispatcher URL provided by Nodies) |
| `HTTP_SERVER_PORT` | Gateway server port | `8080` |
| `POKT_RPC_TIMEOUT` | Max response time for a POKT node to respond | `10s` |
| `POKT_RPC_TIMEOUT` | Max response time for an altruist backup to respond | `10s` |
| `ENVIRONMENT_STAGE` | Log verbosity | `development`, `production` |
| `SESSION_CACHE_TTL` | Duration for sessions to stay in cache | `75m` |
| `POKT_APPLICATIONS_ENCRYPTION_KEY` | User-generated encryption key | `a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` |
| `DB_CONNECTION_URL` | PostgreSQL Database connection URL | `postgres://user:password@localhost:5432/postgres` |

See [.env.sample](..%2F.env.sample) for a sample.

Expand Down

0 comments on commit 8f16be1

Please sign in to comment.