From 1b311090b69d6b507a86a467258b7adb23812ea9 Mon Sep 17 00:00:00 2001 From: Clivern Date: Tue, 18 Jul 2023 00:48:01 +0200 Subject: [PATCH] update links --- README.md | 15 ++--- docs/_documentation/api-and-tf-provider.md | 2 +- docs/how-to/deploy-on-ubuntu/Readme.md | 66 ---------------------- docs/how-to/development/README.md | 46 --------------- 4 files changed, 9 insertions(+), 120 deletions(-) delete mode 100644 docs/how-to/deploy-on-ubuntu/Readme.md delete mode 100644 docs/how-to/development/README.md diff --git a/README.md b/README.md index 721c149..011eaf3 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Lynx is a Fast, Secure and Reliable Terraform Backend. It is built in Elixir wit - 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: for seamless teams, users, projects, environments, and snapshots management. +- [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. @@ -90,16 +90,17 @@ Here is a [video demonstration](https://www.youtube.com/watch?v=YNkHfysr3-0) #### Manual Installation -Please check [this guide](./docs/how-to/deploy-on-ubuntu) for a manual setup on Ubuntu server. +Please check [this guide](https://lynx.clivern.com/documentation/Installation/) for a manual setup on Ubuntu server. #### Important Links -| Name | Description | -| --------------- | -------------------------------------------------------------------------------------------------- | -| 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) | +| 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 diff --git a/docs/_documentation/api-and-tf-provider.md b/docs/_documentation/api-and-tf-provider.md index 4ca636d..1988837 100644 --- a/docs/_documentation/api-and-tf-provider.md +++ b/docs/_documentation/api-and-tf-provider.md @@ -13,7 +13,7 @@ hero: ## Lynx RESTful API -We provide a [Swagger/OpenAPI Specification](https://raw.githubusercontent.com/Clivern/Lynx/main/api.yml) that defines the structure and behavior of a RESTful API. You can use [the swagger editor](https://editor.swagger.io/) to render the API documentation. +We provide a [Swagger/OpenAPI Specification](https://raw.githubusercontent.com/Clivern/Lynx/main/api.yml) that defines the structure and behavior of a RESTful API. You can use [the swagger editor](https://editor.swagger.io/) to render the API documentation or [check this online guide](https://lynx.apidocumentation.com/reference) Here's a brief documentation on how to use this API: diff --git a/docs/how-to/deploy-on-ubuntu/Readme.md b/docs/how-to/deploy-on-ubuntu/Readme.md deleted file mode 100644 index 033e4df..0000000 --- a/docs/how-to/deploy-on-ubuntu/Readme.md +++ /dev/null @@ -1,66 +0,0 @@ -### Ubuntu Deployment - -1. Install elixir and `PostgreSQL` - -```zsh -$ apt-get update -$ apt-get upgrade -y -$ apt-get install -y postgresql \ - elixir \ - erlang-dev \ - make \ - build-essential \ - erlang-os-mon \ - inotify-tools \ - erlang-xmerl -``` - -2. Setup `PostgreSQL` database, username and password - -```zsh -# Create PostgreSQL user with password -$ sudo -u postgres psql -c "CREATE USER lynx WITH PASSWORD 'lynx';" -$ sudo -u postgres psql -c "ALTER USER lynx CREATEDB;" - -# Create database -$ sudo -u postgres psql -c "CREATE DATABASE lynx_dev OWNER lynx;" -``` - -3. Configure Environment Variables: Set up the required environment variables from `.env.example`. - -```zsh -$ mkdir -p /etc/lynx -$ cd /etc/lynx -$ git clone https://github.com/Clivern/Lynx.git app -$ cd /etc/lynx/app -$ cp .env.example .env.local # Adjust the database configs -``` - -4. Migrate the database - -```zsh -$ make deps -$ make migrate -``` - -5. Create a systemd service file `/etc/systemd/system/lynx.service` - -```zsh -[Unit] -Description=Lynx - -[Service] -Type=simple -Environment=HOME=/root -EnvironmentFile=/etc/lynx/app/.env.local -WorkingDirectory=/etc/lynx/app -ExecStart=/usr/bin/mix phx.server - -[Install] -WantedBy=multi-user.target -``` - -```zsh -$ systemctl enable lynx.service -$ systemctl start lynx.service -``` diff --git a/docs/how-to/development/README.md b/docs/how-to/development/README.md deleted file mode 100644 index a20f43f..0000000 --- a/docs/how-to/development/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# Development - -To run `postgresql` with `docker` or `podman` - -```zsh -$ docker run -itd \ - -e POSTGRES_USER=lynx \ - -e POSTGRES_PASSWORD=lynx \ - -e POSTGRES_DB=lynx_dev \ - -p 5432:5432 \ - --name lyx \ - postgres:15.2 - -$ podman run -itd \ - -e POSTGRES_USER=lynx \ - -e POSTGRES_PASSWORD=lynx \ - -e POSTGRES_DB=lynx_dev \ - -p 5432:5432 \ - --name lyx \ - postgres:15.2 - -# https://github.com/dbcli/pgcli -$ psql -h 127.0.0.1 -U lynx -d lynx_dev -W -``` - -Then run `lynx` with the following commands - -```zsh -$ cp .env.example .env.local - -$ export $(cat .env.local | xargs) -``` - -``` -$ make deps - -$ make migrate - -$ make run - -$ make test -``` - -## API Documentation - -To explore the API documentation, copy the content of `api.yml` and paste in https://editor.swagger.io/.