Simplify user README
This commit is contained in:
aseimel
@@ -1,104 +1,52 @@
|
||||
# GESIS OpenCode Desktop Installer
|
||||
|
||||
This repository provides a Windows installer for OpenCode Desktop configured for the GESIS AI Server.
|
||||
|
||||
The installer is intended for GESIS colleagues who want to use OpenCode with their personal GESIS AI Server API key. It downloads the latest OpenCode Desktop for Windows, checks the API key, shows the models available to that key, and writes the OpenCode configuration automatically.
|
||||
This installer sets up OpenCode Desktop for the GESIS AI Server on Windows.
|
||||
|
||||
## Download
|
||||
|
||||
Download and run:
|
||||
Download the current release:
|
||||
|
||||
```text
|
||||
GESIS-OpenCode-Installer.exe
|
||||
```
|
||||
[GESIS-OpenCode-Installer.exe](https://git.gesis.org/seimelan/opencode_gesis/-/releases/v1/downloads/GESIS-OpenCode-Installer.exe)
|
||||
|
||||
Windows may show a security warning because the installer is not code-signed yet. If you downloaded it from the official GESIS GitLab project, choose **More info** and then **Run anyway**.
|
||||
Then open the downloaded file.
|
||||
|
||||
## Before You Start
|
||||
|
||||
You need:
|
||||
|
||||
- Windows 10 or Windows 11
|
||||
- internet access
|
||||
- access to the GESIS AI Server / Open WebUI
|
||||
- your personal GESIS AI Server API key
|
||||
|
||||
Do not share your API key. The installer stores it only in your own OpenCode configuration.
|
||||
Windows may show a warning because the installer is not code-signed. If you downloaded it from this GESIS GitLab project, choose **More info** and then **Run anyway**.
|
||||
|
||||
## Get Your API Key
|
||||
|
||||
Open the GESIS Open WebUI page:
|
||||
Open GESIS Open WebUI:
|
||||
|
||||
[https://ai-openwebui.gesis.org](https://ai-openwebui.gesis.org)
|
||||
|
||||
1. Sign in to Open WebUI.
|
||||
2. Click your profile icon in the top-right corner.
|
||||
Sign in and click your profile icon in the top-right corner.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Choose **Settings**.
|
||||
Choose **Settings**.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Open **Account**.
|
||||
5. Find **API keys** and click **Show**.
|
||||
6. Create or copy your personal API key.
|
||||
Open **Account**, find **API keys**, and click **Show**. Copy your API key.
|
||||
|
||||
|
||||
|
||||
|
||||
If you cannot see API keys, contact the GESIS AI Server / Open WebUI administrators.
|
||||
Do not share your API key with anyone.
|
||||
|
||||
## Install OpenCode
|
||||
## Install
|
||||
|
||||
1. Run `GESIS-OpenCode-Installer.exe`.
|
||||
2. Paste your personal API key.
|
||||
1. Open `GESIS-OpenCode-Installer.exe`.
|
||||
2. Paste your API key.
|
||||
3. Click **Check API key**.
|
||||
4. Select the models you want to use in OpenCode. All available models are selected by default.
|
||||
5. Click **Install selected models**.
|
||||
6. Follow any OpenCode Desktop installer prompts that appear.
|
||||
6. Follow the OpenCode Desktop installer if it opens.
|
||||
|
||||
When finished, start or restart OpenCode Desktop.
|
||||
When the installation is finished, start or restart OpenCode Desktop.
|
||||
|
||||
## What the Installer Does
|
||||
## Problems
|
||||
|
||||
The installer:
|
||||
If your API key is rejected, copy it again from Open WebUI and retry.
|
||||
|
||||
- downloads the latest Windows x64 OpenCode Desktop release
|
||||
- checks your API key against the GESIS AI Server
|
||||
- shows only models available to your API key
|
||||
- writes the selected models to your OpenCode configuration
|
||||
- disables the default OpenCode/Zen providers so the model list stays focused on GESIS
|
||||
- backs up an existing OpenCode config before replacing it
|
||||
|
||||
The config is written to:
|
||||
|
||||
```text
|
||||
%USERPROFILE%\.config\opencode\opencode.json
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If the API key is rejected, create a new API key in Open WebUI and try again.
|
||||
|
||||
If no models are shown, your key may not have access to any models yet. Contact the GESIS AI Server / Open WebUI administrators.
|
||||
If no models are shown, your account may not have model access yet. Contact the GESIS AI Server / Open WebUI administrators.
|
||||
|
||||
If OpenCode still shows old models, close and restart OpenCode Desktop.
|
||||
|
||||
If Windows blocks the installer, make sure you downloaded it from the official GESIS GitLab project.
|
||||
|
||||
## For Maintainers
|
||||
|
||||
Build instructions and source files are included in this repository.
|
||||
|
||||
To rebuild the EXE on Windows:
|
||||
|
||||
```powershell
|
||||
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
|
||||
.\Build-GuiInstaller.ps1
|
||||
```
|
||||
|
||||
Release/versioning rules are documented in `RELEASE.md`. Use simple tags such as `v1`, `v2`, `v3`, and create a new version only when the distributable EXE changes and the project owner explicitly approves the bump.
|
||||
|
||||
GitLab release pages should be attached to an existing approved tag. Do not create a new tag just to create or edit a release page.
|
||||
|
||||
In GitLab, release pages are usually found under **Deploy > Releases** in the project sidebar. If the sidebar does not show **Releases**, open **Code > Tags**, select the existing tag such as `v2`, and create a release from that tag.
|
||||
|
||||
Reference in New Issue
Block a user