README ¶
EdgeX Foundry Security Service - Security Proxy Setup
Go implementation of EdgeX security-proxy-setup service.
Features
- Reverse proxy for EdgeX microservices
- Account creation with optional either OAuth2 or JWT authentication for existing services
- Account creation with arbitrary ACL group list
Build
Use the Makefile in the root directory of the repository to build security-proxy-setup:
$ make cmd/security-proxy-setup/security-proxy-setup
This will create an executable located at cmd/security-proxy-setup/
if successful.
Run security-proxy-setup with different parameters
The binary supports multiple command line parameters
--init // run initialization procedure for security service
--insecureSkipVerify // skip server side SSL verification, primarily for self-signed certs
--configfile // use different configuration file than the default
--reset // reset proxy by removing all customizations
--useradd // user to be added to consume the edgex services, requires 'group' parameter
--group // group that the user belongs to
--userdel // user to be deleted from the the proxy services
An example of use of the parameters can be found in the docker compose file
Docker Build
Go to the root directory of the repository and use the Makefile to build the docker container image for security-proxy-setup
:
$ make docker_security_proxy_setup
It should create a docker image with the name edgexfoundry/docker_security_proxy_setup:<version>-dev
if sucessfully built.
Documentation ¶
Overview ¶
******************************************************************************
- Copyright 2019 Dell Inc. *
- 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. *
- @author: Tingyu Zeng, Dell ******************************************************************************
Click to show internal directories.
Click to hide internal directories.