Skip to content

Commit

Permalink
Document new feature
Browse files Browse the repository at this point in the history
  • Loading branch information
paragonie-security committed Oct 26, 2018
1 parent e3c1c52 commit af56ef9
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/05-instances.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Concurrent Instances

Since version 1.1.0, Chronicle allows multiple instances to be
installed in the same database and document root. **This is an
optional feature.**

To set up your instance, add an entry to local/settings.json like so:

```json
{
"instances": {
"instance_name": "table_prefix"
}
}
```

Next, run the following:

```terminal
php bin/make-tables.php -i instance_name
# Equivalent:
# php bin/make-tables.php --instance=instance_name
```

You can then run the other scripts (`create-client.php`, etc.) with the
`-i` flag.

Finally, when making HTTP requests with the REST API, add the `instance`
query parameter to the request URI.

/chronicle/publish?instance=instance_name
/chronicle/export?instance=instance_name
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* [How to write (publish) to your Chronicle](02-publish.md)
* [How to setup cross-signing to other Chronicles](03-cross-signing.md)
* [How to replicate other Chronicles](04-replication.md)
* [Concurrent Instances](05-instances.md)
* [Internal Developer Documentation](internals)
* [Design Philosophy](internals/01-design-philosophy.md)
* [SQL Tables](internals/02-sql-tables.md)

0 comments on commit af56ef9

Please sign in to comment.