This repo is deprecated. Find the new consolidated one here
This is the API component to the Secure Image application suite. Secure Image is designed to provide a simple yet secure way for people to take sensitive photographs (or image related documentation) and store it outside of the device's camera roll. It also provides a convenient way to extract the images by providing a secure URL to download an album.
Additional component can be fond in these repos:
As part of the build process API documentation is automatically built via apidoc and packaged with the output image. Once deployed the documentation can be viewed at the following URL; update the protocol and host according to your own deployment.
https://api-devex-mpf-secure-test.pathfinder.gov.bc.ca/docs/
Use the OpenShift build.json template in this repo with the following (sample) command.
oc process -f openshift/templates/build.json \
-p GIT_REF=develop \
-p SLACK_SECRET='helloworld' | \
oc create -f -| Parameter | Optional | Description |
|---|---|---|
| GIT_REF | NO | The branch to build from |
| SLACK_SECRET | NO | Slack token to post to channel(s) |
- See the
build.jsontemplate for other optional parameters. ** To build multiple branches you'll use the config file multiple times. This will create errors from theoccommand output that can safely be ignored. For example:Error from server (AlreadyExists): secrets "github" already exists
Use the OpenShift deploy.json template in this repo with the following (sample) command.
oc process -f openshift/templates/deploy.json \
-p NODE_ENV="development" \
-p SSO_CLIENT_SECRET="abc123" \
-p MINIO_VOLUME_CAPACITY=3Gi \
-p ENV_NAMESPACE="devex-mpf-secure-test" \
-p IMAGE_TAG="test" | \
oc create -f -| Parameter | Optional | Description |
|---|---|---|
| NODE_ENV | NO | The node environment name |
| SSO_CLIENT_SECRET | NO | Client secret provided by SSO |
| ENV_NAMESPACE | NO | The environment namespace your deploying to |
| IMAGE_TAG | NO | The image tag you wish to deploy |
- See the
deploy.jsontemplate for other optional parameters.
There are two steps to running this project locally for development:
- Minio
Run a local minio docker image (find them here). The sample command below is using a docker volume named minio_data to store data; see the Docker documentation on how to do this if you're interested. When minio starts it will print the MINIO_ACCESS_KEY and MINIO_SECRET_KEY needed for step two.
docker run -p 9000:9000 --name minio -v minio_data:/data minio/minio server /data- API
Create a file called .env in the root project folder and populate it with the following environment variables; update them as needed.
NODE_ENV=development
MINIO_ACCESS_KEY="XXXXXXXX"
MINIO_SECRET_KEY="YYYYYYYYYYYYYYYY"
MINIO_ENDPOINT="localhost"
SSO_CLIENT_SECRET="00000000-aaaa-aaaa-aaaa-000000000000"
SESSION_SECRET="abc123"
APP_URL="http://localhost:8000"Run the node application with the following command:
npm run devThis project is completed.
Progress to date, known issues, or new features will be documented on our publicly available Trello board here.
Send a note to bcdevexchange@gov.bc.ca and you'll get routed to the right person to help you out.
If you are including a Code of Conduct, make sure that you have a CODE_OF_CONDUCT.md file, and include the following text in here in the README: "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."
Detailed guidance around licenses is available here
Attach the appropriate LICENSE file directly into your repository before you do anything else!
The default license For code repositories is: Apache 2.0
Here is the boiler-plate you should put into the comments header of every source code file as well as the bottom of your README.md:
Copyright 2015 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.
For repos that are made up of docs, wikis and non-code stuff it's Creative Commons Attribution 4.0 International, and should look like this at the bottom of your README.md:
YOUR REPO NAME HERE by the Province of Britich Columbia is licensed under a Creative Commons Attribution 4.0 International License.
and the code for the cc 4.0 footer looks like this:
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons Licence"
style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br /><span
xmlns:dct="http://purl.org/dc/terms/" property="dct:title">YOUR REPO NAME HERE</span> by <span
xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">the Province of Britich Columbia
</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">
Creative Commons Attribution 4.0 International License</a>.