Configuration Service
Overview
configuration-service
is a service responsible for storing and retrieving OSCAL (Open Security Controls Assessment Language) configurations.
Features
- Store OSCAL configurations
- Retrieve OSCAL configurations
Prerequisites
- Docker / Podman
- Docker Compose / Podman Compose
- Go (if running locally without Docker)
Getting Started
Using Docker Compose
You can easily run configuration-service
using Docker Compose. This will also start the required MongoDB and NATS services.
-
Clone the repository:
git clone https://github.com/compliance-framework/configuration-service.git
cd configuration-service
-
Start and stop the services:
make dev # starts service
make dev.stop # stops the service
This command will build the container image for configuration-service and start the containers.
Accessing Swagger Documentation
Once the service is running, you can access the Swagger documentation to test and interact with the API at: http://localhost:8080/swagger/index.html
Configuration
You can configure configuration-service using environment variables. These are located in the .env
file.
Contributing
We welcome contributions to configuration-service!
License
This project is licensed under the Apache-2.0 License - see the LICENSE file for details.