DownloadHow to Install Chronicle
More in-depth guides:
General process:
-
Clone this repository: `git clone https://github.com/paragonie/chronicle.git`
-
Run `composer install`
If you don't have Composer, [go here forComposer installation* instructions](https://getcomposer.org/download/).
-
Run `php bin/install.php` to generate a keypair and basic configuration file.
-
Edit `local/settings.json` to configure your Chronicle. For example, you
can choose a MySQL, PostgreSQL, or SQLite backend. See below.
-
Run `php bin/make-tables.php` to setup the database tables
-
Configure a new virtual host for Apache/nginx/etc. to point to the `public`
directory, OR run `composer start` to launch the built-in web server.
If you want greater performance, be sure to
install the libsodium extension from PECL.
Chronicle uses sodium_compat to
minimize its dependency on PHP extensions written in C.
Configuring local/settings.json
In general, your local/settings.json file will look like one of the samples below,
except with information pertinent to your instance and your public key:
MySQL
To generate MySQL config simply do the following:
php bin/install.php --mysql
The output will be like this:
{
"database": {
"dsn": "mysql:host=localhost;port=3306;dbname=chronicle",
"username": "mysqluser",
"password": "correct horse battery staple"
},
"signing-public-key": "gIQOvAxVbF2zLeanIZDQe7S2gBsabfxM3vP8sjBI_08="
}
There are many available options:
php bin/install.php --mysql \
--host localhost \
--port 3306 \
--database chronicle \
--username mysql_user \
--password mysql_password
Short format options:
php bin/install.php --mysql -h localhost --port 3306 \
-d chronicle -u mysql_user -p mysql_password
PostgreSQL
To generate PostgreSQL config simply do the following:
php bin/install.php --pgsql
The output will be like this:
{
"database": {
"dsn": "pgsql:host=localhost;port=5432;dbname=chronicle",
"username": "pgsqluser",
"password": "correct horse battery staple"
},
"signing-public-key": "gIQOvAxVbF2zLeanIZDQe7S2gBsabfxM3vP8sjBI_08="
}
There are many available options:
php bin/install.php --pgsql \
--host localhost \
--port 5432 \
--database chronicle \
--username pgsql_user \
--password pgsql_password
Short format options:
php bin/install.php --pgsql -h localhost --port 5432 \
-d chronicle -u pgsql_user -p mysql_password
SQLite
To generate SQLite config simply do the following:
php bin/install.php
The output will be like this:
{
"database": {
"dsn": "sqlite:/var/www/chronicle/local/live.db"
},
"signing-public-key": "gIQOvAxVbF2zLeanIZDQe7S2gBsabfxM3vP8sjBI_08="
}
There are many available options:
php bin/install.php --sqlite --database live --extension db
Short format options:
php bin/install.php --sqlite -d live -e db
How to add clients to your Chronicle
First, you'll need the client's Ed25519 public key.
php bin/create-client.php \
--publickey=[the base64url-encoded public key] \
--comment=[any comment you want to use to remember them by]
This will return a message that contains your clientId , which should be included
with this client's HTTP requests to the Chronicle.
You can also specify --administrator if you wish to allow this client to add/remove
other clients from the API. (It is not possible to add or remove administrators through
the API, only normal clients.)
Reading from a Chronicle is 100% public. You do not need to have your key added
to the Chronicle to read from it. Client accounts are needed in order to write to
a Chronicle.
Generating Client Keys
First, run bin/keygen.php . You should get something like this (the example below contains
a valid keypair, but don't use it! Use your own keys instead):
{
"secret-key": "ouSEaSX_MvsQk_LJGDP-HHX2uLkBxEhYOFAe6J3_sZKAhA68DFVsXbMt5qchkNB7tLaAGxpt_Eze8_yyMEj_Tw==",
"public-key": "gIQOvAxVbF2zLeanIZDQe7S2gBsabfxM3vP8sjBI_08="
}
You want to keep your secret-key, well, secret! Your public key can safely
be given out to other Chronicles.
|