Skip to content
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

Merged
merged 2 commits into from
Sep 15, 2023
Merged

Added documentation #17

merged 2 commits into from
Sep 15, 2023

Conversation

dutow
Copy link
Collaborator

@dutow dutow commented Sep 12, 2023

No description provided.

Copy link
Member

@dAdAbird dAdAbird left a 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 Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated

## Build steps

1. Install libjson-c-dev: `apt install libjon-c-dev`
Copy link
Collaborator

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.

Copy link
Collaborator Author

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
Copy link
Collaborator

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

Copy link
Collaborator Author

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)
Copy link
Collaborator

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?

Copy link
Collaborator Author

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

Copy link
Collaborator

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?

Copy link
Collaborator Author

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.

@hqakhtar hqakhtar force-pushed the tuple_enc branch 2 times, most recently from 3d128f9 to 78c64b3 Compare September 13, 2023 15:31
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)
Copy link
Collaborator

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?

Copy link
Collaborator

@ImTheKai ImTheKai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dutow dutow merged commit d1aafa3 into Percona-Lab:tuple_enc Sep 15, 2023
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants