Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clivern/lynx
🐺 A Fast, Secure and Reliable Terraform Backend, Set up in Minutes.
https://github.com/clivern/lynx
clivern lynx terraform terraform-backend terraform-http-backend terraform-project terraform-workspace
Last synced: 18 days ago
JSON representation
🐺 A Fast, Secure and Reliable Terraform Backend, Set up in Minutes.
- Host: GitHub
- URL: https://github.com/clivern/lynx
- Owner: Clivern
- License: mit
- Created: 2023-02-18T19:32:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-29T00:28:23.000Z (7 months ago)
- Last Synced: 2024-05-29T06:15:22.611Z (7 months ago)
- Topics: clivern, lynx, terraform, terraform-backend, terraform-http-backend, terraform-project, terraform-workspace
- Language: Elixir
- Homepage: https://lynx.clivern.com/
- Size: 32.2 MB
- Stars: 200
- Watchers: 5
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-tf - Lynx - Fast, Secure and Reliable Terraform Backend. It has a user-friendly dashboard, project and environment management, state versioning, locking and snapshots support. (Self-hosted Terraform Platforms / IDE)
- awesome-elixir - Lynx - A Fast, Secure and Reliable Terraform Backend, Set up in Minutes. (Applications)
README
Lynx
A Fast, Secure and Reliable Terraform Backend, Set up in Minutes.
Lynx is a Fast, Secure and Reliable Terraform Backend. It is built in Elixir with Phoenix framework.
#### Features:
- Simplified Setup: Easy installation and maintenance for hassle-free usage.
- Team Collaboration: Manage multiple teams and users seamlessly.
- User-Friendly Interface: Enjoy a visually appealing dashboard for intuitive navigation.
- Project Flexibility: Support for multiple projects within each team.
- Environment Management: Create and manage multiple environments per project.
- State Versioning: Keep track of Terraform state versions for better control.
- Rollback Capability: Easily revert to previous states for efficient infrastructure management.
- Terraform Locking Support: The project also supports Terraform locking, ensuring state integrity and preventing concurrent operations that could lead to data corruption
- [RESTful Endpoints](https://lynx.apidocumentation.com/reference): for seamless teams, users, projects, environments, and snapshots management.
- Snapshots Support: for both projects and environments to ensure data integrity and provide recovery options at specific points in time.
- [Terraform Provider](https://github.com/Clivern/terraform-provider-lynx): Automate creation/updates of teams, users, projects, environments and snapshots with terraform.
#### Upcoming Features:
- Single Sign-On (SSO): Support for OAuth2 Providers like Azure AD OAuth, Keycloak, Okta ... etc
#### Quick Start
> [!IMPORTANT]
>
> Make sure you have docker and docker-compose installed for the quick start.
Lynx requires a [PostgreSQL](https://www.postgresql.org/) database. No Object Storage is required.
To run `Lynx` alone on port `4000` on docker.
```bash
$ wget https://raw.githubusercontent.com/Clivern/Lynx/main/docker-compose.yml \
-O docker-compose.yml
$ docker-compose up -d
```
To run `Lynx` behind nginx reverse proxy on port `80` on docker.
```bash
$ wget https://raw.githubusercontent.com/Clivern/Lynx/main/docker-compose-nginx.yml \
-O docker-compose.yml
$ wget https://raw.githubusercontent.com/Clivern/Lynx/main/nginx.conf \
-O nginx.conf
$ docker-compose up -d
```
To run a 3 Nodes of `Lynx` behind nginx reverse proxy on port `80` on docker.
```bash
$ wget https://raw.githubusercontent.com/Clivern/Lynx/main/docker-compose-cluster.yml \
-O docker-compose.yml
$ wget https://raw.githubusercontent.com/Clivern/Lynx/main/nginx-cluster.conf \
-O nginx.conf
$ docker-compose up -d
```
Here is a [video demonstration](https://www.youtube.com/watch?v=YNkHfysr3-0)
#### Manual Installation
Please check [this guide](https://lynx.clivern.com/documentation/Installation/) for a manual setup on Ubuntu server.
#### Important Links
| Name | Description |
| ---------------- | -------------------------------------------------------------------------------------------------- |
| API Documentation| [https://lynx.apidocumentation.com/reference](https://lynx.apidocumentation.com/reference)
| Bug Tracker | [Submit issues on GitHub](https://github.com/clivern/lynx/issues) |
| Security Issues | [Submit security vulnerability on GitHub](https://github.com/Clivern/Lynx/security/advisories/new) |
| Contributing | [Read the contribution guide here](./docs/how-to/development/Reamd.md) |
#### License
© 2023, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).
Lynx is authored and maintained by [@clivern](http://github.com/clivern).