From 26968e05bc529a08c5b23fa8822e10513708183a Mon Sep 17 00:00:00 2001 From: derekpierre Date: Mon, 5 Jul 2021 09:15:59 -0400 Subject: [PATCH] Rename docker image to nucypher/porter instead of nucypher/nucypher-porter. Update documentation regarding the port that the Porter service runs on. --- .circleci/config.yml | 12 ++++++------ deploy/docker/porter/docker-compose.yml | 6 +++--- docs/source/application_development/porter.rst | 11 ++++++----- 3 files changed, 15 insertions(+), 14 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index c1ff7f9ce..390a63011 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -880,12 +880,12 @@ jobs: - run: name: Build Porter Docker Image command: | - docker build -f deploy/docker/porter/Dockerfile --cache-from=nucypher-porter -t nucypher/nucypher-porter:circle . + docker build -f deploy/docker/porter/Dockerfile --cache-from=nucypher-porter -t nucypher/porter:circle . - run: name: Save Porter Docker Image Layer Cache command: | mkdir -p ~/docker - docker save -o ~/docker/nucypher-porter.tar nucypher/nucypher-porter:circle + docker save -o ~/docker/nucypher-porter.tar nucypher/porter:circle - save_cache: key: v1-{{ .Branch }}-{{ arch }} paths: @@ -989,10 +989,10 @@ jobs: name: Push Tagged NuCypher Porter Docker Images command: | echo $DOCKER_PASSWORD | docker login -u $DOCKER_USERNAME --password-stdin - docker tag nucypher/nucypher-porter:circle nucypher/nucypher-porter:$CIRCLE_TAG - docker tag nucypher/nucypher-porter:circle nucypher/nucypher-porter:latest - docker push nucypher/nucypher-porter:$CIRCLE_TAG - docker push nucypher/nucypher-porter:latest + docker tag nucypher/porter:circle nucypher/porter:$CIRCLE_TAG + docker tag nucypher/porter:circle nucypher/porter:latest + docker push nucypher/porter:$CIRCLE_TAG + docker push nucypher/porter:latest statistical_tests: <<: *python_37_base diff --git a/deploy/docker/porter/docker-compose.yml b/deploy/docker/porter/docker-compose.yml index 957189055..5c7372562 100644 --- a/deploy/docker/porter/docker-compose.yml +++ b/deploy/docker/porter/docker-compose.yml @@ -3,7 +3,7 @@ version: '3' services: porter-http: restart: on-failure - image: nucypher-porter:latest + image: porter:latest container_name: porter-http build: context: ../../.. @@ -20,7 +20,7 @@ services: porter-https: restart: on-failure - image: nucypher-porter:latest + image: porter:latest container_name: porter-https ports: # Default Porter port @@ -37,7 +37,7 @@ services: porter-https-auth: restart: on-failure - image: nucypher-porter:latest + image: porter:latest container_name: porter-https-auth ports: # Default Porter port diff --git a/docs/source/application_development/porter.rst b/docs/source/application_development/porter.rst index e4f6a88b6..ff83d1640 100644 --- a/docs/source/application_development/porter.rst +++ b/docs/source/application_development/porter.rst @@ -23,7 +23,8 @@ Running Porter .. note:: - By default the Porter service will run on port 9155, unless specified otherwise. + If running the Porter service using Docker or Docker Compose, it will run on port 80 (HTTP) or 443 (HTTPS). If + running via the CLI the default port is 9155, unless specified otherwise via the ``--http-port`` option. Security ^^^^^^^^ @@ -65,7 +66,7 @@ Run Porter within Docker without acquiring or installing the ``nucypher`` codeba .. code:: bash - $ docker pull nucypher/nucypher-porter:latest + $ docker pull nucypher/porter:latest #. Run Porter service @@ -77,7 +78,7 @@ Run Porter within Docker without acquiring or installing the ``nucypher`` codeba --name porter-http \ -v ~/.local/share/nucypher/:/root/.local/share/nucypher \ -p 80:9155 \ - nucypher/nucypher-porter:latest \ + nucypher/porter:latest \ nucypher porter run \ --provider \ --network @@ -93,7 +94,7 @@ Run Porter within Docker without acquiring or installing the ``nucypher`` codeba -v ~/.local/share/nucypher/:/root/.local/share/nucypher \ -v :/etc/porter/tls \ -p 443:9155 \ - nucypher/nucypher-porter:latest \ + nucypher/porter:latest \ nucypher porter run \ --provider \ --network \ @@ -110,7 +111,7 @@ Run Porter within Docker without acquiring or installing the ``nucypher`` codeba -v :/etc/porter/tls \ -v :/etc/porter/auth/htpasswd \ -p 443:9155 \ - nucypher/nucypher-porter:latest \ + nucypher/porter:latest \ nucypher porter run \ --provider \ --network \