This project contains a Dockerfile and associated files that can be used to setup an automated database documentation tool.
It is compatible with environment variables common OpenShift application deployments.
SchemaSpy itself is an open source project located here: http://schemaspy.sourceforge.net/
The application is meant to be installed as an OpenShift application (see below); however, you can also run it locally, if you have the following dependencies installed:
- Node.js
- Java (only JRE necessary; no java is compiled)
- Graphviz
The environment must have values for each of the variables below defined:
DATABASE_SERVICE_NAME - the hostname of the database server.
POSTGRESQL_USER - username that will be used to connect to the database
POSTGRESQL_PASSWORD - password that will be used to connect to the database
POSTGRESQL_DATABASE - name of the database to connect to.
Normally these would be set by the OpenShift template used to deploy the application.
All database activity occurs on application startup, after which static content is served up on a basic HTTP server.
Run npm install to get the required Node.js dependencies, then npm start to run the server.
The command below will create a BuildConfig, DeploymentConfig, and ancillary resources (service, etc.) in your current OpenShift project. Apprpriate values should be substitute for each of the environment variables in the command below.
oc new-app https://github.com/bcgov/SchemaSpy.git -e DATABASE_SERVICE_NAME=postgresql -e POSTGRESQL_USER=django -e POSTGRESQL_PASSWORD=xyz1234 -e POSTGRESQL_DATABASE=default
Please report any issues.
Pull requests are always welcome.
If you would like to contribute, please see our contributing guidelines.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Copyright 2016 Province of British Columbia
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
This repository is maintained by BC Ministry of Transportation. Click here for a complete list of our repositories on GitHub.