-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added documentation #17
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
just minor grammatical suggestions
README.md
Outdated
|
||
## Build steps | ||
|
||
1. Install libjson-c-dev: `apt install libjon-c-dev` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First time we actually mention a package manager and as such pinpoint it to Debian/Ubuntu.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've mentinoed that's an exmaple for ubuntu - as I'm using that, I didn't test other systems.
README.md
Outdated
4. Create the extension: `CREATE EXTENSION pg_tde;` | ||
5. Set the location of the keyring configuration file in postgresql.conf: `pg_tde.keyringConfigFile = '/where/to/put/the/keyring.json'` | ||
6. Create the keyring configuration file (see example keyring configuration) | ||
6. Restart the postgres server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ordering should be 7. here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
3. Restart the postgres server | ||
4. Create the extension: `CREATE EXTENSION pg_tde;` | ||
5. Set the location of the keyring configuration file in postgresql.conf: `pg_tde.keyringConfigFile = '/where/to/put/the/keyring.json'` | ||
6. Create the keyring configuration file (see example keyring configuration) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we mention what is needed here? Just an empty file? Is a string or hash value needed inside? How to create?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an example later in the file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok but what's needed for the datafile? Just an empty file? What needs to be inside this file in which format?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's created and managed by the server - I'll mention this to the documentation.
3d128f9
to
78c64b3
Compare
3. Restart the postgres server | ||
4. Create the extension: `CREATE EXTENSION pg_tde;` | ||
5. Set the location of the keyring configuration file in postgresql.conf: `pg_tde.keyringConfigFile = '/where/to/put/the/keyring.json'` | ||
6. Create the keyring configuration file (see example keyring configuration) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok but what's needed for the datafile? Just an empty file? What needs to be inside this file in which format?
bf3caa9
to
a9c8f7c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.