Server Configuration

The prestd configuration is via an environment variable or toml file. Starting from version v1.2.0 it will be possible to use prestd without any environment variable or the toml file, but the configurations used will be the described in the default column bellow.

Environment variables

TOML

Optionally the prestd can be configured by TOML file.

You can follow this sample and create your own prest.toml file and put this on the same folder that you run prestd command.

 1migrations = "./migrations"
 2
 3# debug = true
 4# enabling debug mode will disable JWT authorization
 5
 6[http]
 7port = 3000
 8
 9[jwt]
10key = "secret"
11algo = "HS256"
12
13[auth]
14enabled = true
15type = "body"
16encrypt = "MD5"
17table = "prest_users"
18username = "username"
19password = "password"
20
21[pg]
22host = "127.0.0.1"
23user = "postgres"
24pass = "mypass"
25port = 5432
26database = "prest"
27single = true
28## or used cloud factor
29# URL = "postgresql://user:pass@localhost/mydatabase/?sslmode=disable"
30
31[ssl]
32mode = "disable"
33sslcert = "./PATH"
34sslkey = "./PATH"
35sslrootcert = "./PATH"
36
37[expose]
38enabled = true
39databases = true
40schemas = true
41tables = true

Authorization

JWT

JWT middleware is enabled by default. To disable JWT need to set default to false. Enabling debug mode will also disable it.

1[jwt]
2default = false

1Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

The HS256 algorithm is used by default.

The JWT algorithm can be specified by using either the environment variable PREST_JWT_ALGO or the algo parameter in the section [jwt] of the prest.toml configuration file.

The supported signing algorithms are:

• The HMAC signing method: HS256,HS384,HS512
• The RSA signing method: RS256,RS384,RS512
• The ECDSA signing method: ES256,ES384,ES512

White list

By default the endpoints /auth do not require JWT, the whitelist option serves to configure which endpoints will not ask for jwt token

1[jwt]
2default = true
3whitelist = ["\/auth", "\/ping", "\/ping\/.*"]

Auth

pREST has support in jwt token generation based on two fields (example user and password), being possible to use an existing table from your database to login configuring some parameters in the configuration file (or environment variable), by default this feature is disabled.

1[auth]
2enabled = true
3type = "body"
4encrypt = "MD5"
5table = "prest_users"
6username = "username"
7password = "password"

to validate all endpoints with generated jwt token must be activated jwt option

Expose Data

The expose data setting enables you to configure if you want users to be able to reach listing endpoints, such as:

• /databases
• /schemas
• /tables

An example of a configuration file disabling all listings:

1# previous toml content
2[expose]
3    enabled = true

If you want to disable just the database listing:

1# previous toml content
2[expose]
3    databases = true

Default values for Exposure Settings

SSL

There are 4 options to set on ssl mode:

Debug Mode

Set environment variable PREST_DEBUG or debug=true on top of prest.toml file.

1PREST_DEBUG=true

Single mode

Serving multiple databases over the same API with prestd is doable, but it is not currently supported. Thus it was introduced by default the single configuration, it can be disabled by the following config in the toml file:

1[pg]
2    single = false

Since v1.1.2 it is a lot safer to use multiple databases, but not yet in the ideal state of security that we want, so use it in your own risk.

CORS support

Cross-Origin Resource Sharing

Read the specific topic where we talk about CROS here.

Health check endpoint

If you need to setup a health check on your deployment (ECS/EKS or others), you can use /_health as a provider of this information.

The server will return 503 whenever a pREST is not working properly.