mirror of
https://github.com/coder/coder.git
synced 2026-06-03 04:58:23 +00:00
Danielle Maywood
f41275eb39
Relates to https://github.com/coder/internal/issues/711 This PR implements a project discovery mechanism that searches for any dev container projects and makes them visible in the UI so that they can be started. To make the wording on the site more clear, "Rebuild" has been changed to "Start" when there is no container associated with a known dev container configuration. I've also made it so that site will show the dev container config path when there is no other name available. ### Design decisions Just want to ensure my explanation for a few design decisions are noted down: - We only search for dev container configurations inside git repositories - We only search for these git repositories if they're at the top level or a direct child of the agent directory. This limited approach is to reduce the amount of files we ultimately walk when trying to find these projects. It makes sense to limit it to only the agent directory, although I'm open to expanding how deep we search.
66 lines
2.6 KiB
Plaintext
66 lines
2.6 KiB
Plaintext
coder v0.0.0-devel
|
|
|
|
USAGE:
|
|
coder agent [flags]
|
|
|
|
Starts the Coder workspace agent.
|
|
|
|
OPTIONS:
|
|
--log-human string, $CODER_AGENT_LOGGING_HUMAN (default: /dev/stderr)
|
|
Output human-readable logs to a given file.
|
|
|
|
--log-json string, $CODER_AGENT_LOGGING_JSON
|
|
Output JSON logs to a given file.
|
|
|
|
--log-stackdriver string, $CODER_AGENT_LOGGING_STACKDRIVER
|
|
Output Stackdriver compatible logs to a given file.
|
|
|
|
--agent-header string-array, $CODER_AGENT_HEADER
|
|
Additional HTTP headers added to all requests. Provide as key=value.
|
|
Can be specified multiple times.
|
|
|
|
--agent-header-command string, $CODER_AGENT_HEADER_COMMAND
|
|
An external command that outputs additional HTTP headers added to all
|
|
requests. The command must output each header as `key=value` on its
|
|
own line.
|
|
|
|
--auth string, $CODER_AGENT_AUTH (default: token)
|
|
Specify the authentication type to use for the agent.
|
|
|
|
--block-file-transfer bool, $CODER_AGENT_BLOCK_FILE_TRANSFER (default: false)
|
|
Block file transfer using known applications: nc,rsync,scp,sftp.
|
|
|
|
--debug-address string, $CODER_AGENT_DEBUG_ADDRESS (default: 127.0.0.1:2113)
|
|
The bind address to serve a debug HTTP server.
|
|
|
|
--devcontainers-enable bool, $CODER_AGENT_DEVCONTAINERS_ENABLE (default: true)
|
|
Allow the agent to automatically detect running devcontainers.
|
|
|
|
--devcontainers-project-discovery-enable bool, $CODER_AGENT_DEVCONTAINERS_PROJECT_DISCOVERY_ENABLE (default: true)
|
|
Allow the agent to search the filesystem for devcontainer projects.
|
|
|
|
--log-dir string, $CODER_AGENT_LOG_DIR (default: /tmp)
|
|
Specify the location for the agent log files.
|
|
|
|
--no-reap bool
|
|
Do not start a process reaper.
|
|
|
|
--pprof-address string, $CODER_AGENT_PPROF_ADDRESS (default: 127.0.0.1:6060)
|
|
The address to serve pprof.
|
|
|
|
--prometheus-address string, $CODER_AGENT_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
|
|
The bind address to serve Prometheus metrics.
|
|
|
|
--script-data-dir string, $CODER_AGENT_SCRIPT_DATA_DIR (default: /tmp)
|
|
Specify the location for storing script data.
|
|
|
|
--ssh-max-timeout duration, $CODER_AGENT_SSH_MAX_TIMEOUT (default: 72h)
|
|
Specify the max timeout for a SSH connection, it is advisable to set
|
|
it to a minimum of 60s, but no more than 72h.
|
|
|
|
--tailnet-listen-port int, $CODER_AGENT_TAILNET_LISTEN_PORT (default: 0)
|
|
Specify a static port for Tailscale to use for listening.
|
|
|
|
———
|
|
Run `coder --help` for a list of global options.
|