|
1 |
| -:warning: This plugin needs the new modular driver system to work, which is available since Metabase version 0.32. |
2 |
| - |
3 | 1 | # Firebird driver for metabase
|
4 | 2 |
|
5 | 3 | This driver enables metabase to connect to [FirebirdSQL](https://firebirdsql.org/) databases.
|
6 | 4 |
|
7 | 5 | ## Installation:
|
8 | 6 |
|
9 |
| -* Make sure you have installed a recent Metabase Version that supports drivers as plugins. (>=0.32) |
10 |
| -* Download the [latest release](https://github.com/evosec/metabase-firebird-driver/releases/latest) of the Firebird driver or build it from source. (See below) |
| 7 | +* Make sure you have installed a recent Metabase Version. |
| 8 | +* Download the [latest release](https://github.com/evosec/metabase-firebird-driver/releases/latest) of the Firebird driver or [build it from source](#building-from-source). |
11 | 9 | * Create the `plugins` directory if it doesn't already exist. By default that directory is next to the metabase.jar file, but you can specify a different directory by setting the environment varianble `MB_PLUGINS_DIR`.
|
12 | 10 | * Just drop the `firebird.metabase-driver.jar` in the plugins directory. On startup, metabase will load the plugin and the driver should be available.
|
13 | 11 |
|
14 | 12 | ## Authentication issues when using Legacy_Auth
|
15 | 13 |
|
16 |
| -The latest releases are built with version 4.x of Jaybird (the Firebird JDBC driver), [which no longer supports Legacy_Auth](https://www.firebirdsql.org/file/documentation/drivers_documentation/java/4.0.0/release_notes.html#removed-legacy_auth-from-default-authentication-plugins). |
| 14 | +The latest releases are built with version 4.x of Jaybird (the Firebird JDBC driver), [which no longer supports Legacy_Auth](https://www.firebirdsql.org/file/documentation/drivers_documentation/java/4.0.0/release_notes.html#removed-legacy_auth-from-default-authentication-plugins). |
17 | 15 |
|
18 |
| -If you have problems accessing your database ([#14](https://github.com/evosec/metabase-firebird-driver/issues/14)) you can use the release artifact `firebird.metabase-driver_jaybird-3.jar` which is built with Jaybird 3.x. |
| 16 | +:warning: First of all: Legacy_Auth is disabled for a reason. You should only use the following workarounds if you have no way of using a more secure authentication method. :warning: |
19 | 17 |
|
20 |
| -## Building from source: |
| 18 | +If you really need to access your database using Legacy_Auth ([#14](https://github.com/evosec/metabase-firebird-driver/issues/14)) you can [add it to the authentication plugins](https://www.firebirdsql.org/file/documentation/drivers_documentation/java/4.0.0/release_notes.html#configure-authentication-plugins). For example: |
| 19 | +``` |
| 20 | +jdbc:firebirdsql://localhost/employee?authPlugins=Legacy_Auth |
| 21 | +``` |
21 | 22 |
|
22 |
| -For a detailed description, take a look at the [official documentation](https://github.com/metabase/metabase/wiki/Writing-A-Driver). |
| 23 | +If that does not work for you, you can use the release artifact `firebird.metabase-driver_jaybird-3.jar` which is built with Jaybird 3.x. |
23 | 24 |
|
24 |
| -#### Prepare a local Metabase installation for building drivers |
| 25 | +## Building from source: |
| 26 | + |
| 27 | +For a detailed description, take a look at the [official documentation](https://www.metabase.com/docs/latest/developers-guide/drivers/start.html). |
25 | 28 |
|
26 |
| -* Download the Metabase sources (>=0.32) |
27 |
| -* Compile a local Metabase installation for building drivers |
| 29 | +* Checkout the main metabase repository and the firebird driver repository in the same parent directory: |
28 | 30 | ```
|
29 |
| -lein install-for-building-drivers |
| 31 | +workspace |
| 32 | + - metabase |
| 33 | + - metabase-firebird-driver |
30 | 34 | ```
|
31 |
| - |
32 |
| -#### Build the driver |
33 |
| - |
34 |
| -* Checkout the Firebird driver sources to `{metabase-source-dir}/modules/drivers/firebird` |
35 |
| -* Build the driver. This will create the .jar file in the directory `target/uberjar`. Just copy that file to your plugins directory and you are good to go! |
| 35 | +* Run the `build.sh` script from the metabase-firebird-driver repository |
36 | 36 | ```
|
37 |
| -cd {metabase-source-dir}/modules/drivers/firebird |
38 |
| -lein clean |
39 |
| -LEIN_SNAPSHOTS_IN_RELEASE=true DEBUG=1 lein uberjar |
| 37 | +cd metabase-firebird-driver |
| 38 | +./build.sh |
40 | 39 | ```
|
| 40 | +* The driver will now be built. The .jar file can be found in the `target` directory. |
0 commit comments