diff --git a/docs/install/server.md b/docs/install/server.md index 0ac40bc29..e5d731c2b 100644 --- a/docs/install/server.md +++ b/docs/install/server.md @@ -22,13 +22,13 @@ $ ./postgrest - Also it would be good to create packages for Homebrew, and apt.

+ Also it would be good to create a package for apt.

We'll learn the meaning of the command line flags later, but here is a minimal example of running the app. It does all operations as user `postgres`, including for unauthenticated requests. ```sh -$ ./postgrest -d dbname -U postgres --a postgres --v1schema public +$ ./postgrest -d dbname -U postgres -a postgres --v1schema public ``` ### Building from Source @@ -53,6 +53,29 @@ stack exec postgrest -- arg1 arg2 If you want to run the test suite, stack can do that too: `stack test`. +### Install via Homebrew (Mac OS X) + +You can use the Homebrew package manager to install PostgREST on Mac + +```bash +# Ensure brew is up to date +brew update + +# Check for any problems with brew's setup +brew doctor + +# Install the postgrest package +brew install postgrest +``` + +This will automatically install PostgreSQL as a dependency (see the [Installing PostgreSQL](#installing-postgresql) section for setup instructions). The process tends to take around 15 minutes to install the package and its dependencies. + +After installation completes, the tool is added to your $PATH and can be used from anywhere with: + +```bash +postgrest --help +``` + ### Installing PostgreSQL To use PostgREST you will need an underlying database. You can use something like Amazon [RDS](https://aws.amazon.com/rds/) but installing your own locally is cheaper and more convenient for development.