Skip to content

Commit 4b05812

Browse files
feat: add public one-line remote installer for DeepSQL (#118)
<!-- CURSOR_AGENT_PR_BODY_BEGIN --> ## Summary Adds a `remote-install.sh` script for one-liner DeepSQL self-host installation: ```bash curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash ``` ## Features - **Platform detection**: Linux (amd64/arm64) and macOS support - **Prerequisite checks**: Validates bash, curl, git, Docker, Compose v2, and buildx - **Auto-versioning**: Fetches latest release tag from GitHub API, falls back to `main` - **Shallow clone**: Uses `--depth 1` for fast cloning - **Environment setup**: Creates `.env` from template - **Optional auto-install**: `--yes` flag for noninteractive mode - **Remote-friendly guidance**: Pre-clone Docker/buildx messages use `raw.githubusercontent.com` URLs ## Options | Flag | Description | |------|-------------| | `-y, --yes` | Run `install.sh` automatically after setup | | `--skip-docker-check` | Skip Docker/Compose/buildx verification | | `--branch <ref>` | Use specific branch or tag instead of latest release | ## Environment Variables | Variable | Default | Description | |----------|---------|-------------| | `DEEPSQL_HOME` | `$HOME/deepsql` | Installation directory | | `DEEPSQL_BRANCH` | (latest release) | Branch or tag to checkout | ## Security - Downloads only from GitHub (`raw.githubusercontent.com`, `github.com`, `api.github.com`) - No third-party binaries — everything builds from source - Transparent: users can inspect the script before running ## Follow-up Fix (latest commit) - **Bug fixed**: `check_docker()` previously printed `sudo ./scripts/self-host/bootstrap-server.sh` when Docker was missing on Linux, but that path doesn't exist until after `clone_or_update` runs - **Solution**: Changed to remote one-liner: `curl -fsSL https://raw.githubusercontent.com/.../bootstrap-server.sh | sudo bash` - **Also fixed**: Same issue in buildx-missing guidance - **Hardened**: `get_latest_release_tag()` now explicitly: - Matches only `^v[0-9]` product tags (e.g., `v1.3.0`) - Excludes `desktop-v*` and other prefixed tags <!-- CURSOR_AGENT_PR_BODY_END --> <div><a href="https://cursor.com/agents/bc-830fb434-8a8c-5629-b56f-51579a3b4090?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a href="https://cursor.com/background-agent?bcId=bc-830fb434-8a8c-5629-b56f-51579a3b4090&cursor_ref=pr_footer&cursor_cta=open_in_cursor"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img alt="Open in Cursor" width="131" height="28" src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;</div> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
1 parent 8b391c7 commit 4b05812

2 files changed

Lines changed: 483 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@ DeepSQL Desktop first ship + Agent/Brain/Editor hardening. Notes:
2323

2424
## Quick start
2525

26+
### One-liner install
27+
28+
```bash
29+
curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
30+
```
31+
32+
This checks prerequisites, clones the latest release to `~/deepsql`, and guides you
33+
through configuration. See [`scripts/self-host/remote-install.sh`](scripts/self-host/remote-install.sh)
34+
for options (`--yes` for noninteractive, `--branch` for a specific version).
35+
36+
### Step-by-step
37+
2638
Five steps, in order. Budget about fifteen minutes, most of it waiting on the first build.
2739

2840
### 1. Check you have what you need

0 commit comments

Comments
 (0)