jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs to note rquired arguments

Browse Source
This commit is contained in:
Joe Nelson
2016-02-04 16:34:36 -08:00
parent a044398552
commit 7702d38267
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/install/server.md
+3 -3
View File
@@ -65,7 +65,7 @@ If you want to run the test suite, stack can do that too: `stack test`.
### Running the Server ### Running the Server
```bash ```bash
postgrest postgres://user:pass@host:port/db [flags] postgrest postgres://user:pass@host:port/db -s public -a anon_user [other flags]
``` ```
The user in the connection string is the "authenticator role," i.e. The user in the connection string is the "authenticator role," i.e.
@@ -80,11 +80,11 @@ The possible flags are:
<dd>The port on which the server will listen for HTTP requests. <dd>The port on which the server will listen for HTTP requests.
Defaults to 3000.</dd> Defaults to 3000.</dd>
<dt>-a, --anonymous</dt> <dt>-a, --anonymous (required)</dt>
<dd>The database role used to execute commands for those requests <dd>The database role used to execute commands for those requests
which provide no JWT authorization.</dd> which provide no JWT authorization.</dd>
<dt>-s, --schema</dt> <dt>-s, --schema (required)</dt>
<dd>The db schema which you want to expose as an API. For historical <dd>The db schema which you want to expose as an API. For historical
reasons it defaults to <code>1</code>, but you're more likely reasons it defaults to <code>1</code>, but you're more likely
to want to choose a value of <code>public</code>.</dd> to want to choose a value of <code>public</code>.</dd>