Skip to content

Document unsigned desktop install notes #14

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

Merged
dev-ik merged 1 commit into from
Jun 21, 2026
Merged

Document unsigned desktop install notes #14

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
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,13 @@ Use immutable version tags such as `docker.io/d8vik/specdock:v1.0.2`; the projec

Download desktop installers from [GitHub Releases](https://github.com/dev-ik/specdock/releases). The desktop app runs the SpecDock API on `127.0.0.1` with proxy and mock features disabled by default; `Settings -> Desktop runtime` controls local mock/proxy settings. See [Desktop](docs/DESKTOP.md) for packaging and release workflow details.

Desktop builds are unsigned. Verify `SHA256SUMS.txt` before bypassing platform
warnings. On macOS, clear quarantine with
`sudo xattr -dr com.apple.quarantine /Applications/SpecDock.app` and run
`open /Applications/SpecDock.app`. On Windows, SmartScreen can warn; use
`More info -> Run anyway` only after checksum verification. On Linux, make the
AppImage executable with `chmod +x SpecDock*.AppImage` or use the `.tar.gz`.

## Configuration

Public/demo deployments should keep backend proxy mode disabled:
Expand Down Expand Up @@ -226,24 +233,14 @@ docs Architecture, security, deployment, smoke tests, and roadmap
## Documentation

Start with the [master plan](docs/SPECDOCK_MASTER_PLAN.md),
[implementation plan](docs/IMPLEMENTATION_PLAN.md), [API contracts](docs/API_CONTRACTS.md),
[implementation plan](docs/IMPLEMENTATION_PLAN.md),
[security guide](SECURITY.md), [release checklist](docs/RELEASE.md), and
[roadmap](docs/ROADMAP.md).

## Open-Source Hygiene

The repository intentionally ignores local-only files:

```txt
.env
.history
.playwright-mcp
docs_deprecated
docs/BOOTSTRAP_REPOSITORY.md
docs/TASKS.md
```

Do not commit local credentials, private proxy targets, provider-specific hosting entrypoints, or generated build output.
Do not commit local credentials, private proxy targets, provider-specific
hosting entrypoints, or generated build output.

## License

Expand Down
14 changes: 14 additions & 0 deletions docs/DESKTOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,20 @@ sudo xattr -dr com.apple.quarantine /Applications/SpecDock.app
open /Applications/SpecDock.app
```

Unsigned Windows downloads can show Microsoft Defender SmartScreen warnings.
Verify `SHA256SUMS.txt`, then choose `More info -> Run anyway` only if the
checksum matches the GitHub Release asset.

Linux AppImage downloads may need executable permissions:

```bash
chmod +x SpecDock*.AppImage
./SpecDock*.AppImage
```

If AppImage does not start because FUSE is unavailable on your distribution,
use the `.tar.gz` archive from the same release.

The GitHub `Desktop Release` workflow maps repository secrets to those
environment variables and verifies signatures when credentials are present. In
GitHub, store the Apple `.p8` notarization key as `APPLE_API_KEY_BASE64`; the
Expand Down