From 5a5abd1c105428f09af7b87457222aaa39f23d57 Mon Sep 17 00:00:00 2001 From: Mario Ranftl Date: Mon, 29 Jan 2024 18:27:36 +0100 Subject: [PATCH] ref closes github issues #2 #15 #13 --- CHANGELOG.md | 3 +++ README.md | 24 ++++++++++++------------ 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4dc5b42..1ac54c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,10 +45,12 @@ - Going forward, images are built via GitHub Actions and published to GitHub packages. - ARM Docker images - Arm64 is now supported (Apple Silicon M1/M2/M3), we publish a multi-arch image (`linux/amd64,linux/arm64`). + - Closes [#15](https://github.com/allaboutapps/integresql/issues/15) - We added the `POST /api/v1/templates/:hash/tests/:id/recreate` endpoint to the API. - You can use it to express that you no longer using this database and it can be recreated and returned to the pool. - Using this endpoint means you want to break out of our FIFO (first in, first out) recreating queue and get your test-database recreated as soon as possible. - Explicitly calling recreate is **optional** of course! + - Closes [#2](https://github.com/allaboutapps/integresql/issues/2) - Minor: Added woodpecker/drone setup (internal allaboutapps CI/CD) ### Changed @@ -60,6 +62,7 @@ - Closes [#13](https://github.com/allaboutapps/integresql/issues/13) - Logging and Debugging Improvements - Introduced zerolog for better logging in the pool and manager modules. Debug statements were refined, and unnecessary print debugging was disabled. +- Changed details around installing locally in README.md (still not recommended, use the Docker image instead), closes [#7](https://github.com/allaboutapps/integresql/issues/7) ### Environment Variables diff --git a/README.md b/README.md index f09cdd5..c41d65a 100644 --- a/README.md +++ b/README.md @@ -37,22 +37,12 @@ Do your engineers a favour by allowing them to write fast executing, parallel an ## Install -### Install using Docker (preferred) - A minimal Docker image containing a pre-built `IntegreSQL` executable is available at [Github Packages](https://github.com/allaboutapps/integresql/releases). ```bash docker pull ghcr.io/allaboutapps/integresql ``` -### Install locally - -Installing `IntegreSQL` locally requires a working [Go](https://golang.org/dl/) (1.14 or above) environment. Install the `IntegreSQL` executable to your Go bin folder: - -```bash -go get github.com/allaboutapps/integresql/cmd/server -``` - ## Usage ### Run using Docker (preferred) @@ -127,9 +117,19 @@ volumes: You may also refer to our [go-starter `docker-compose.yml`](https://github.com/allaboutapps/go-starter/blob/master/docker-compose.yml). -### Run locally +### Run locally (not recommended) + +Installing `IntegreSQL` locally requires a working [Go](https://golang.org/dl/) (1.14 or above) environment. Install the `IntegreSQL` executable to your Go bin folder: + +```bash +# This installs the latest version of IntegreSQL into your $GOBIN +go install github.com/allaboutapps/integresql/cmd/server@latest + +# you may want to rename the binary to integresql after installing: +mv $GOBIN/server $GOBIN/integresql +``` -Running the `IntegreSQL` server locally requires configuration via exported environment variables (see below): +Running the `IntegreSQL` server locally requires configuration via exported environment variables (see below). ```bash export INTEGRESQL_PORT=5000