diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c98bc25 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2008-2018 Tom Preston-Werner and Jekyll contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index cbf88b6..daf4d09 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ This repo contains a Dockerfile to run and set up an insight explorer for the Zcash blockchain. + +To build the image run: + +`docker build -t ianamunoz/zcash-insight-explorer:v1.1.1 .` + +* Note that this build will pull in all the parameters so it is a bit heavy at 2.48GB. It will require some bandwidth and beware of your /var/lib directory if you have a default docker install. + +To run locally without to test operation run: + +``` +docker run -d \ +-p 80:3001 \ +ianamunoz/zcash-insight-explorer:v1.1.1 +``` + +The `docker-service.sh` file shows you might might manually run it as a service behind a traefik reverse proxy as seen for example in the `docker-compose.yml`.