-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy path.env.example
More file actions
160 lines (133 loc) · 6.92 KB
/
.env.example
File metadata and controls
160 lines (133 loc) · 6.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# =============================================================================
# .----------. .----------.
# / /| ____ _ ____ / /|
# +----------+ | / ___|___ __| | ___| __ ) _____ __ +----------+ |
# | | | | | / _ \ / _` |/ _ \ _ \ / _ \ \/ / | | |
# | | + | |__| (_) | (_| | __/ |_) | (_) > < | | +
# | |/ \____\___/ \__,_|\___|____/ \___/_/\_\ | |/
# +----------+ +----------+
# =============================================================================
# 📦 CodeBox - OpenCode Docker Environment Configuration
# =============================================================================
# This is the example environment configuration file for CodeBox.
# Copy this file to .env and fill in your actual values. It will automatically be
# copied when you first run the codebox.sh script if .env does not already exist.
# Most settings can be left as default or blank.
# RECCOMMENDED:
# - Set HOST_OPENCODE_CONFIG_DIR to persist OpenCode config across sessions
# - Set DOCKER_PACKAGES to add useful CLI tools at build time
# - Add your API keys (if needed) for access to GPT, Claude, Gemini, etc.
# - Change TZ to your local timezone for correct session times [Default: America/Edmonton]
# - Add PROTECTED_DIRS if you want to protect additional directories
# =============================================================================
# Docker Build Configuration
# =============================================================================
# User configuration - automatically uses your current user's UID/GID
# You can override these if needed, but leaving them blank uses automatic detection
# UID=
# GID=
# USERNAME=dev
# OpenCode version to install (use "latest" [default] or specific version like "v1.1.20")
# OPENCODE_VERSION=latest
# Container root directory name (default: BOX)
# This creates paths like /BOX/hostname/dirname inside the container
# CODEBOX_NAME=BOX
# Optional extra packages to add at build time (SPACE-SEPARATED)
# Packages already in the Dockerfile:
# - ca-certificates, ubuntu-keyring, curl, git, bash, ripgrep, less, jq, tzdata
# Optional examples: vim, nano, htop, wget, unzip, tree, openssh-client
# Example: DOCKER_PACKAGES=tree vim wget unzip
# DOCKER_PACKAGES=
# Enable optional Snakemake runtime stack (default: false)
# When true, codebox installs Python + micromamba and creates an env with snakemake + mamba.
# ENABLE_SNAKEMAKE_STACK=false
# Minimum Snakemake version used when ENABLE_SNAKEMAKE_STACK=true
# SNAKEMAKE_VERSION=8.30
# =============================================================================
# OpenCode Config Directory
# =============================================================================
# This directory will be mounted into the container at /home/${USERNAME}/.config/opencode
# It stores OpenCode configuration including opencode.json (settings), agents, commands and plugins.
# This does not affect session data or state (for example, favorites), which are always mounted at
# ~/.local/share/opencode and ~/.local/state/opencode.
#
# If left blank [default], OpenCode will still use ~/.config/opencode inside the container,
# but the contents will be ephemeral and discarded when the container is removed.
#
# If a directory is provided, the configuration will persist across sessions.
# The path must be absolute.
# This can be the standard host location (~/.config/opencode) or any directory you
# choose, such as a folder managed in your dotfiles or tracked in git.
# See the 'config_example' README.md for an example opencode config directory structure.
# HOST_OPENCODE_CONFIG_DIR=/path/to/home/.config/opencode
# =============================================================================
# LLM Provider API Keys (uncomment and add as needed)
# =============================================================================
# OpenAI Plus/Pro and GitHub Copilot subscriptions
# - See the README for instructions on connecting
# with the /connect command inside OpenCode.
# Anthropic (Claude models)
# Get your key at: https://console.anthropic.com/
# ANTHROPIC_API_KEY=
# OpenAI (GPT models)
# Get your key at: https://platform.openai.com/api-keys
# OPENAI_API_KEY=
# Google AI (Gemini models)
# Get your key at: https://makersuite.google.com/app/apikey
# GOOGLE_API_KEY=
# OpenCode Zen (provided by OpenCode))
# Get your key at: https://opencode.ai/auth
# OPENCODE_API_KEY=
# Groq (Fast inference)
# Get your key at: https://console.groq.com/keys
# GROQ_API_KEY=
# Additional providers (uncomment and add as needed)
# COHERE_API_KEY=
# MISTRAL_API_KEY=
# PERPLEXITY_API_KEY=
# DEEPSEEK_API_KEY=
# =============================================================================
# Git Configuration
# =============================================================================
# These are used when OpenCode makes commits on your behalf
# GIT_AUTHOR_NAME=Your Name
# GIT_AUTHOR_EMAIL=your.email@example.com
# GIT_COMMITTER_NAME=Your Name
# GIT_COMMITTER_EMAIL=your.email@example.com
# =============================================================================
# OpenCode Server Configuration (Optional)
# =============================================================================
# Use these if you're connecting to a remote OpenCode server
# This has not been tested yet
# OPENCODE_SERVER_URL=https://your-opencode-server.com
# OPENCODE_SERVER_PASSWORD=your-secure-password
# =============================================================================
# Advanced Configuration (Optional)
# =============================================================================
# Uncomment and modify as needed
# Custom git config path
# GIT_CONFIG_PATH=${HOME}/.gitconfig
# Docker resource limits
# DOCKER_MEMORY_LIMIT=8G
# DOCKER_CPU_LIMIT=4
# Local timezone for correct session times
# If unset, codebox defaults to America/Edmonton at runtime
# TZ=America/Edmonton
# =============================================================================
# Directory Protection
# =============================================================================
# Additional directories that require --force flag to run codebox
# Provide a colon-separated list of absolute paths
# Default protected: $HOME and any directory outside $HOME
# Example: PROTECTED_DIRS="/Users/username/important:/Users/username/production"
# PROTECTED_DIRS=
# =============================================================================
# CodeBox Configuration
# =============================================================================
# Display volume mounts in startup banner (true/false) [default: true]
# SHOW_MOUNTS=true
# Automatically prune Docker build cache and dangling images after image rebuild/update
# AUTO_PRUNE=false
# Maximum age of build cache to keep when pruning (used by docker builder prune --filter until=...)
# Examples: 24h, 168h, 720h
# PRUNE_MAX_AGE=168h