Skip to content

docs: expose desktop install guide #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dicnunz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: expose desktop install guide #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/guides/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Practical how-to guides for developing, deploying, and extending OpenSail.
| Guide | Description | When to Use |
|-------|-------------|-------------|
| [Docker Setup](docker-setup.md) | Set up OpenSail from scratch with Docker Compose | **Start here**. First-time setup, new developers |
| [Desktop Install](desktop-install.md) | Install the desktop app or run the desktop client from source | Local-first use, desktop packaging, installer testing |
| [Local Development](local-development.md) | Run backend/frontend natively (without Docker) | Faster iteration, debugging |
| [Minikube Setup](minikube-setup.md) | Deploy to local Kubernetes cluster | Testing K8s features locally |
| [AWS Deployment](aws-deployment.md) | Deploy to AWS EKS production | Production deployment |
Expand Down
10 changes: 6 additions & 4 deletions docs/guides/desktop-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,23 @@ Common to all platforms:
## 3. Install from release

Direct downloads live at
[github.com/TesslateAI/opensail/releases](https://github.com/TesslateAI/opensail/releases).
Pick the latest tagged release and grab the artifact for your OS.
[github.com/TesslateAI/opensail/releases](https://github.com/TesslateAI/opensail/releases)
when a desktop release includes installer assets. If the latest release has no
desktop installer attached yet, use the build-from-source flow below.

### macOS (`.dmg`)

1. Download `OpenSail_<version>_aarch64.dmg` (Apple Silicon) or
`OpenSail_<version>_x64.dmg` (Intel).
`OpenSail_<version>_x64.dmg` (Intel) when those assets are attached to the
release.
2. Open the DMG and drag `OpenSail.app` into `/Applications`.
3. First launch: right-click the app, pick "Open", then "Open" again at the
Gatekeeper prompt. Shipped builds are codesigned with a Developer ID and
notarized, so subsequent launches skip the prompt.

### Windows (`.msi`)

1. Download `OpenSail_<version>_x64_en-US.msi`.
1. Download `OpenSail_<version>_x64_en-US.msi` when it is attached to the release.
2. Double-click and step through the installer. It installs to
`%LOCALAPPDATA%\Programs\OpenSail` by default and pins a Start menu entry.
3. If SmartScreen flags the installer as "unrecognized", click "More info"
Expand Down
Loading