Skip to content
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
Binary file modified en/.gitbook/assets/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.
6 changes: 4 additions & 2 deletions en/collaborative-work/sqldatabase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@

## 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 **Shared database** and **Connect to shared database**. The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings. 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.
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 **Shared database** and **Connect to shared database**. The **Connect to shared database** dialog will open. The quickest way to fill it in is to paste the connection URL of your database (as shown by your hosting provider, e.g. `postgres://user:password@host:5432/database?sslmode=require`, a JDBC URL, the keyword form `host=… port=… dbname=… user=… password=…`, or even the whole `psql 'postgres://…'` command line) into the **Connection URL** field: host, port, database, user, and password are filled in automatically. Alternatively, enter these details by hand. If you like you can save your password by ticking the **Remember password** checkbox; it is then kept in your operating system's credential store (keychain). The checkbox is unavailable if no credential store can be reached.

Check warning on line 11 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.Passive] 'be reached' may be passive voice. Use active voice if you can. Raw Output: {"message": "[write-good.Passive] 'be reached' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 11, "column": 910}}}, "severity": "WARNING"}

Check warning on line 11 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.TooWordy] 'it is' is too wordy. Raw Output: {"message": "[write-good.TooWordy] 'it is' is too wordy.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 11, "column": 783}}}, "severity": "WARNING"}

Check warning on line 11 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.TooWordy] 'Alternatively' is too wordy. Raw Output: {"message": "[write-good.TooWordy] 'Alternatively' is too wordy.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 11, "column": 653}}}, "severity": "WARNING"}

Check warning on line 11 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.Passive] 'are filled' may be passive voice. Use active voice if you can. Raw Output: {"message": "[write-good.Passive] 'are filled' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 11, "column": 624}}}, "severity": "WARNING"}

Settings that are rarely needed (SSL and a custom JDBC URL for the *expert mode*) are found in the collapsible **Advanced** section. When a pasted URL contains parameters JabRef has no dedicated field for (such as `sslmode=require`), expert mode is switched on and the parameters are kept in the custom JDBC URL, so the connection is made exactly as the URL says.

Check warning on line 13 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.Passive] 'is made' may be passive voice. Use active voice if you can. Raw Output: {"message": "[write-good.Passive] 'is made' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 13, "column": 332}}}, "severity": "WARNING"}

Check warning on line 13 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.Passive] 'are kept' may be passive voice. Use active voice if you can. Raw Output: {"message": "[write-good.Passive] 'are kept' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 13, "column": 281}}}, "severity": "WARNING"}

Check warning on line 13 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.Passive] 'is switched' may be passive voice. Use active voice if you can. Raw Output: {"message": "[write-good.Passive] 'is switched' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 13, "column": 247}}}, "severity": "WARNING"}

Check warning on line 13 in en/collaborative-work/sqldatabase/README.md

View workflow job for this annotation

GitHub Actions / vale-lint

[vale] reported by reviewdog 🐶 [write-good.Passive] 'are found' may be passive voice. Use active voice if you can. Raw Output: {"message": "[write-good.Passive] 'are found' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sqldatabase/README.md", "range": {"start": {"line": 13, "column": 83}}}, "severity": "WARNING"}

If the database was already used by an older version of JabRef, its content is migrated to the new table structure automatically when the first client connects. The old tables are kept untouched, so older JabRef versions can still be used with them.

### SSL configuration

Checking **Use SSL** encrypts the connection without authenticating the server — the same behavior as `psql` — so managed PostgreSQL providers work without any certificate setup. A separate keystore is no longer needed. If you additionally want the server certificate verified, use expert mode with a custom JDBC URL containing `sslmode=verify-full` (see the [PostgreSQL JDBC documentation](https://jdbc.postgresql.org/documentation/ssl/)).
Tick **Use SSL** in the **Advanced** section to require an encrypted connection. Like `psql`, this does not verify the server's certificate, so managed PostgreSQL providers with their own certificate authorities work out of the box; a pasted URL with `sslmode=require` ticks the box for you. If you want the server certificate verified, use the expert mode with a JDBC URL such as `jdbc:postgresql://host:5432/database?sslmode=verify-full&sslrootcert=/path/to/ca.pem`; a pasted URL with `sslmode=verify-full` sets this up automatically.

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

Expand Down
Loading