Skip to content

Commit a1911d6

Browse files
committed
Updated README.md to include instructions to build FDW
1 parent a618266 commit a1911d6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,36 @@ Suppose you want to build the FDW for a plugin with an alias `aws` from a GitHub
6464
$ make standalone plugin="aws"
6565
```
6666

67+
#### To build a local plugin or an external plugin(not maintained by Turbot)
68+
69+
Suppose you want to build the FDW for your own plugin(not maintained by Turbot) located at https://github.com/francois2metz/steampipe-plugin-scalingo. You would need to build the FDW by running the following command:
70+
```
71+
$ make standalone plugin="scalingo" plugin_github_url="github.com/francois2metz/steampipe-plugin-scalingo"
72+
```
73+
74+
#### Installing the built standalone FDW
75+
76+
Once you have built the standalone FDW, the binaries will be available in a folder `build-Darwin` or `build-Linux` depending on your OS. Run the `install.sh` script available in that directory. This will detect the installed PostrgeSQL version and location and copy the binaries there.
77+
78+
```
79+
➜ steampipe-postgres-fdw ✗ cd build-Darwin
80+
➜ build-Darwin ✗ ./install.sh
81+
82+
Discovered:
83+
- PostgreSQL version: 14
84+
- PostgreSQL location: /opt/homebrew/Cellar/postgresql@14/14.13_1
85+
86+
Install Steampipe PostgreSQL FDW for version 14 in /opt/homebrew/Cellar/postgresql@14/14.13_1? (Y/n):
87+
88+
Installing...
89+
90+
Successfully installed steampipe_postgres_scalingo extension!
91+
92+
Files have been copied to:
93+
- Library directory: /opt/homebrew/lib/postgresql@14
94+
- Extension directory: /opt/homebrew/share/postgresql@14/extension/
95+
```
96+
6797
## Open Source & Contributing
6898

6999
This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!

0 commit comments

Comments
 (0)