Seth Van Niekerk
f0bf451aa5
Some checks failed
Build & Push Docker Image / build-and-publish (push) Failing after 59s
98 lines
3.5 KiB
Markdown
98 lines
3.5 KiB
Markdown
# RuneLite Docker
|
|
|
|
A containerized RuneLite client that runs in your browser using Selkies WebRTC technology. This allows you to play Old School RuneScape through RuneLite from any device with a web browser, including mobile devices and tablets.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name runelite \
|
|
-p 8181:8181 \
|
|
-v /path/to/appdata/.runelite:/config/.runelite:rw \
|
|
-v /path/to/appdata/.credentials/credentials.properties:/config/.runelite/credentials.properties:ro \
|
|
ghcr.io/sethwv/rune-docker:latest
|
|
```
|
|
|
|
### GPU Acceleration (Recommended for Better Performance)
|
|
|
|
RuneLite supports GPU rendering via OpenGL, which is enabled by default in this container. For optimal performance with hardware acceleration:
|
|
|
|
**NVIDIA GPUs:**
|
|
```bash
|
|
docker run -d \
|
|
--name runelite \
|
|
--gpus all \
|
|
-p 8181:8181 \
|
|
-v /path/to/appdata/.runelite:/config/.runelite:rw \
|
|
ghcr.io/sethwv/rune-docker:latest
|
|
```
|
|
|
|
**AMD/Intel GPUs:**
|
|
```bash
|
|
docker run -d \
|
|
--name runelite \
|
|
--device /dev/dri:/dev/dri \
|
|
-p 8181:8181 \
|
|
-v /path/to/appdata/.runelite:/config/.runelite:rw \
|
|
ghcr.io/sethwv/rune-docker:latest
|
|
```
|
|
|
|
**Note:** GPU mode provides significantly better FPS and reduced CPU usage. Software rendering (Mesa) is used as fallback if GPU is unavailable.
|
|
|
|
## Access
|
|
|
|
Once the container is running, access RuneLite through your web browser:
|
|
|
|
- **HTTPS (Recommended)**: `https://localhost:8181`
|
|
- **PWA Installation**: On mobile devices, use "Add to Home Screen" for a native app experience
|
|
|
|
## Mobile Setup (iOS/Android)
|
|
|
|
1. Open your browser and navigate to the container URL
|
|
2. Tap the "Share" button (iOS) or browser menu (Android)
|
|
3. Select "Add to Home Screen" or "Install App"
|
|
4. The RuneLite PWA will be added to your home screen
|
|
5. Launch from home screen for a fullscreen experience
|
|
|
|
## RuneLite Account Integration
|
|
|
|
### ⚠️ Important Security Warning
|
|
|
|
To use RuneLite with your account logged in (for plugin sync and settings), you must provide a complete `.runelite` folder from an existing RuneLite installation. This folder contains sensitive authentication data.
|
|
|
|
**Critical Security Implications:**
|
|
|
|
1. **One-Click Account Access**: Anyone who can access the web interface URL can immediately access your logged-in RuneScape character without additional authentication
|
|
2. **Credential File Exposure**: If logged in, you will need to include `credentials.properties` with your account authentication tokens
|
|
3. **Full Account Control**: Logged-in users have complete access to your character
|
|
|
|
### Setting Up Account Integration
|
|
|
|
If you accept these risks and want RuneLite account features:
|
|
|
|
1. **For Jagex Account users:**
|
|
- Ensure `credentials.properties` is present in your `.runelite` folder
|
|
- See [RuneLite Jagex Account Guide](https://github.com/runelite/runelite/wiki/Using-Jagex-Accounts)
|
|
|
|
2. **Prepare your .runelite folder:**
|
|
```bash
|
|
# Copy from your local RuneLite installation
|
|
# Windows: %USERPROFILE%\.runelite
|
|
# macOS: ~/.runelite
|
|
# Linux: ~/.runelite
|
|
cp -r ~/.runelite /path/to/appdata/.runelite
|
|
|
|
# Set proper permissions for security
|
|
chmod 700 /path/to/appdata/.runelite
|
|
```
|
|
|
|
3. **For enhanced security, separate credentials file:**
|
|
```bash
|
|
# Create secure credentials directory
|
|
mkdir -p /path/to/appdata/.credentials
|
|
chmod 700 /path/to/appdata/.credentials
|
|
|
|
# Move credentials file to separate location
|
|
mv /path/to/appdata/.runelite/credentials.properties /path/to/appdata/.credentials/
|
|
chmod 600 /path/to/appdata/.credentials/credentials.properties
|
|
``` |