gianluigipp/spectacle-central repository overview

⁠Spectacle⁠

In modern distributed systems the behavior of the product is defined across multiple components and services, and usually developed by multiple teams, as a result, the documentation is fragmented and difficult to find.

Additionally, the system tends to change faster than the documentation which makes the latter unreliable.

Spectacle provides a solution for generating documentation from the multiple codebases in a modern system and then storing it in a central repository that anyone can access.

⁠Spectacle Central⁠

Repository for the living documentation generated by Spectacle DSL⁠, it allows to centralize the documentation generated from multiple executions of the DSL across multiple repositories, so even though the docs are generated from multiple sources it can be queried from a central place which increase the value for the organization as a whole.

⁠Config

The service requires a PostgreSql database with a user with write permissions, it uses Flyway to setup the schema and update it when upgrading to a newer version.

Environment Variables:

• ADMIN_USERNAME: Username of the admin user, it's the main user of the service, it can be used to authenticate both in the API and in the Web App.
• ADMIN_PASSWORD
• GUEST_USERNAME: Readonly user that can be used to authenticate in the Web App.
• GUEST_PASSWORD
• DATABASE_URL: one variable holding all the connection detail using the format USERNAME:PASSWORD@HOST:PORT/DATABASE, additionally you can use the below DATABASE_XXX variables, if booth options are present the more specific variable take precedence.
• DATABASE_HOST
• DATABASE_PORT
• DATABASE_NAME
• DATABASE_USERNAME
• DATABASE_PASSWORD

⁠Run On-Premise

The Recommended way to install Spectacle Central in your organization is using the public Docker Image in Docker Hub:

export DATABASE_URL=[YOUR_URL] 
docker run -p 8080:8080 -e DATABASE_URL --name spectacle-central gianluigipp/spectacle-central