Skip to content

Update shared SQL information #193

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

Merged
merged 1 commit into from
Aug 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions en/SQLDatabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,22 @@ since: 3.6

JabRef is able to support collaborative work using a shared SQL database.
This feature is available since JabRef 3.6.
If you used to work with an older version of JabRef, please refer to [SQLDatabaseMigration](SQLDatabaseMigration) for information how to update your data.

## Usage

To use this feature you have to connect to a remote database.
To do so you have to open **File** in the menu bar and then click the **Connect to shared database** item.
The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings.
Under the field **Database type** you can choose between PostgreSQL (at least version 9.1), MySQL (not recommended, because there is no life synchronization), and Oracle depending on your shared database.
Under the field **Database type** you can choose between PostgreSQL (at least version 9.1), MySQL (at least 5.5, not recommended, because there is no live synchronization), and Oracle depending on your shared database.
Then, you have to fill out the remaining fields with the according information.
If you like you can save your password by clicking the **Remember password?** checkbox.

### SSL configuration
Since version 5.0 JabRef supports secure SSL connection to the database. For PostgreSQL make sure the server supports SSL and you have correctly setup the [certificates](https://www.postgresql.org/docs/current/static/ssl-tcp.html).
Then [convert the client certificates](https://jdbc.postgresql.org/documentation/head/ssl-client.html) into a java readable format and import them into a (custom) keystore.
For MySQL the procedure is similar. [Setting up MySQL with SSL](https://dev.mysql.com/doc/refman/8.0/en/using-encrypted-connections.html) and [converting the certificates](https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html) for the java keystore. However, it has only been tested with PostgreSQL.
Once the certificates are imported into the keystore, specify the path to the keystore file in the connection dialog and the password for acessing the keystore.

![Screenshot of Connect to shared database dialog](./images/open-shared-database-dialog.png)

After connecting to your shared database, your main window should look like this:
Expand Down
Binary file modified en/images/open-shared-database-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/images/open-shared-databse-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.