Skip to content

Commit

Permalink
doc: fix broken links (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
ravisuhag committed Jan 31, 2023
1 parent 4e4ce0b commit 3f0a2e7
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/docs/tour/setup-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Shield binary contains both the CLI client and the server itself. Each has it's
Dependencies:

- PostgreSQL
- [SpiceDB]((https://github.com/authzed/spicedb))
- [SpiceDB]((https://github.com/authzed/spicedb)

You need to prepare and run above dependencies first before running Shield. Shield also has a `docker-compose.yaml` file in its repo that has all required dependencies. If you are interested to use it, you just need to git clone the repo and run `docker-compose up` in the root project.

Expand Down Expand Up @@ -55,7 +55,7 @@ spicedb:

You need to define the policies in a YAML file and pass it's directory path to `resources_config_path`. The rules for each path shall be defined in another YAML file and pass it's path to `ruleset`.

Next, let's look at a example policy configuration for a backend `entropy` with `firehose` and `dagger` resource types. Also, we have defined roles for `organizations` and `project` to demonstrate shield's flexibility to define policy for different category of namespaces.
Next, let's look at a example policy configuration for a backend `entropy` with `firehose` and `dagger` resource types. Also, we have defined roles for `organizations` and `project` to demonstrate shield's flexibility to define policy for different category of namespaces.

```
entropy:
Expand Down Expand Up @@ -213,6 +213,7 @@ rules:
```

### Migrating the server

Database migration is required during the first server initialization. In addition, re-running the migration command might be needed in a new release to apply the new schema changes (if any). It's safer to always re-run the migration script before deploying/starting a new release.

To initialize the database schema, Run Migrations with the following command:
Expand Down Expand Up @@ -255,8 +256,6 @@ $ \dt

![SpiceDB tables](./spicedb-tables.png)



### Starting the server

Now, it's time to start the server, but before that, let's open a browser tab and open `localhost:8080` to have a look at the permission schema on SpiceDB.
Expand Down Expand Up @@ -290,4 +289,3 @@ pong
Let's verify in the browser, if the SpiceDB permission schema is updated

![SpiceDB permission schema after](./permission-schema-after.png)

0 comments on commit 3f0a2e7

Please sign in to comment.