Via environment variables or via toml file.
Optionally the pREST 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 prest
command.
migrations = "./migrations"
# debug = true
# enabling debug mode will disable JWT authorization
[http]
port = 6000
# Port 6000 is blocked on windows. You must change to 8080 or any unblocked port
[jwt]
key = "secret"
algo = "HS256"
[auth]
enabled = true
type = "body"
encrypt = "MD5"
table = "prest_users"
username = "username"
password = "password"
[pg]
host = "127.0.0.1"
user = "postgres"
pass = "mypass"
port = 5432
database = "prest"
## or used cloud factor
# URL = "postgresql://user:pass@localhost/mydatabase/?sslmode=disable"
[ssl]
mode = "disable"
sslcert = "./PATH"
sslkey = "./PATH"
sslrootcert = "./PATH"
JWT middleware is enabled by default. To disable JWT need to set default to false. Enabling debug mode will also disable it.
[jwt]
default = false
Authorization: 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:
HS256
,HS384
,HS512
RS256
,RS384
,RS512
ES256
,ES384
,ES512
By default the endpoints /auth
do not require JWT, the whitelist option serves to configure which endpoints will not ask for jwt token
[jwt]
default = true
whitelist = ["\/auth", "\/ping", "\/ping\/.*"]
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.
[auth]
enabled = true
type = "body"
encrypt = "MD5"
table = "prest_users"
username = "username"
password = "password"
Name | Description |
---|---|
enabled | Boolean field that activates or deactivates token generation endpoint support |
type | Type that will receive the login, support for body and http basic authentication |
encrypt | Type of encryption used in password field, support for MD5 and SHA1 |
table | Table name we will consult (query) |
username | User field that will be consulted - if your software uses email just abstract name username (at pREST code level it was necessary to define an internal standard) |
password | Password field that will be consulted |
to validate all endpoints with generated jwt token must be activated jwt option
There is 4 options to set on ssl mode:
disable
- SSL off by defaultrequire
- Always SSL (skip verification)verify-ca
- Always SSL (verify that the certificate presented by the server was signed by a trusted CA)verify-full
- Always SSL (verify that the certification presented by the server was signed by a trusted CA and the server host name matches the one in the certificate)Set environment variable PREST_DEBUG
or debug=true
on top of prest.toml file.
PREST_DEBUG=true
--url
and --path
flags are optional if pREST configurations already set.
# env var for migrations directory
PREST_MIGRATIONS
# apply all available migrations
prestd migrate --url driver://url --path ./migrations up
# roll back all migrations
prestd migrate --url driver://url --path ./migrations down
# roll back the most recently applied migration, then run it again.
prestd migrate --url driver://url --path ./migrations redo
# run down and then up command
prestd migrate --url driver://url --path ./migrations reset
# show the current migration version
prestd migrate --url driver://url --path ./migrations version
# apply the next n migrations
prestd migrate --url driver://url --path ./migrations next +1
prestd migrate --url driver://url --path ./migrations next +2
prestd migrate --url driver://url --path ./migrations next +n
# roll back the previous n migrations
prestd migrate --url driver://url --path ./migrations next -1
prestd migrate --url driver://url --path ./migrations next -2
prestd migrate --url driver://url --path ./migrations next -n
# create or remove default pREST authentication table
prestd migrate up auth
prestd migrate down auth