Open Contracting Partnership operates a hosted instance of the Kingfisher tool suite for the use of OCP staff and OCDS Team members. If you think you should have access to this, contact mailto:firstname.lastname@example.org.
You can connect to the server via SSH to run commands, or via a Postgres client to run queries on the database. Details of this are below.
From time to time, we create development servers to try things out before deploying them. If you’re involved in the development of new Kingfisher components, you may be asked to log into the dev server to try things out. If so, substitiute the address of the dev server you’ve been provided with for the address of the live server in the examples below.
Over the course of a typical use of Hosted Kingfisher, you’ll need to log in to run scrapers, then log out and back in as a different user to run process operations, and potentially connect to Postgres to carry out database operations.
Access for kingfisher-scrape¶
If you’re running scrapers, SSH in as the ocdskfs user:
Once logged in, you can run scrapers as per the kingfisher-scrape documentation
Access for kingfisher-process¶
If you’re running process operations, SSH in as the ocdskfp user:
Once logged in, you can run process operations as per the kingfisher-process documentation
Access for analysis¶
If you’re running analysis operations, SSH in as the analysis user:
Once logged in, you can take advantage of the powerful server to carry out analysis operations, such as using flatten-tool on files, more quickly than on your local machine. The analysis user has read-only access to the files downloaded by the scrapers. Please remember to delete your files when you’re done!
Access to the archives¶
There is an archive server which contains files that have been downloaded previously but are no longer held on the main server. In some cases, the data from them is still in the process database, but they are retained for reference. If you would like to access them, SSH in as the archive user:
Access for Postgres Database queries¶
In order to access the database, you’ll need a Postgres client such as pgadmin <https://www.pgadmin.org/>, and some details that are stored on the server.
- To obtain the details, SSH into the server as the ocdskfp user (as above), and then run:::
- cat ~/.pgpass
The output contains two lines, for the two different database users that are available. It is recommended that you use the read-only user unless you’re making changes to the database. The lines have the format:
These should be all the details you need to connect with a Postgres client.
Access for Redash¶
A Redash server is available. Contact Open Data Services for access.