-
Notifications
You must be signed in to change notification settings - Fork 7
Self hosting improvements #169
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,39 +3,67 @@ title: "Configuration Overview" | |
| description: "Arcade Engine Configuration Overview" | ||
| --- | ||
|
|
||
| import { Tabs } from "nextra/components"; | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| # Configuration Overview | ||
|
|
||
| Arcade uses configuration files to manage engine settings and default values. When you install the Arcade Engine, two files are created: | ||
|
|
||
| - The `engine.yaml` file for engine configuration. | ||
| - The `engine.env` file for environment variables. | ||
|
|
||
| Let's explore each file to understand their purpose and how to locate them. | ||
|
|
||
| ## Engine configuration file | ||
|
|
||
| The `engine.yaml` file controls Arcade Engine settings and manages supported models. It supports variable expansion so you can integrate secrets and environment values seamlessly. You can customize this file to suit your setup. For more details, check the [Engine Configuration](/home/configure/engine) page. | ||
|
|
||
| Choose your installation method to view the default location of `engine.yaml`: | ||
|
|
||
| <Tabs items={['macOS (Homebrew)', 'Ubuntu/Debian (APT)', 'Manual Download']}> | ||
| <Tabs.Tab> | ||
| ```bash | ||
| $HOMEBREW_REPOSITORY/etc/arcade-engine/engine.yaml | ||
| ``` | ||
| </Tabs.Tab> | ||
| <Tabs.Tab> | ||
| ```bash | ||
| /etc/arcade-ai/engine.yaml | ||
| ``` | ||
| </Tabs.Tab> | ||
| <Tabs.Tab> | ||
| ```bash | ||
| $HOME/.arcade/engine.yaml | ||
| ``` | ||
| <Note>To manually download the engine.yaml, you can get an example from the [Configuration Templates](/home/configure/templates#engineyaml) and add it to `$HOME/.arcade/engine.yaml`.</Note> | ||
| </Tabs.Tab> | ||
| </Tabs> | ||
|
|
||
| ## Engine environment file | ||
|
|
||
| The `engine.env` file contains default environment variables that power Arcade Engine. You can override these defaults by exporting your own variables or by editing the file directly. | ||
|
|
||
| Select your installation method below to see the default path for `engine.env`: | ||
|
|
||
| <Tabs items={['macOS (Homebrew)', 'Ubuntu/Debian (APT)', 'Manual Download']}> | ||
| <Tabs.Tab> | ||
| ```bash | ||
| $HOMEBREW_REPOSITORY/etc/arcade-engine/engine.env | ||
| ``` | ||
| </Tabs.Tab> | ||
| <Tabs.Tab> | ||
| ```bash | ||
| /etc/arcade-ai/engine.env | ||
| ``` | ||
| </Tabs.Tab> | ||
| <Tabs.Tab> | ||
| ```bash | ||
| $HOME/.arcade/engine.env | ||
| ``` | ||
| <Note>To manually download the `engine.env`, refer to the [Configuration Templates](/home/configure/templates#engineenv).</Note> | ||
| </Tabs.Tab> | ||
| </Tabs> | ||
|
|
||
| # Configuration | ||
|
|
||
| ## Configuration Files | ||
| On [installation](/home/install/local), Arcade creates an `engine.yaml` configuration file and an `engine.env` environment variable file containing default values. | ||
|
|
||
| See the [Specifying a Config File](/home/configure/engine#specify-a-config-file) for usage. | ||
|
|
||
| ### Engine Configuration | ||
|
|
||
| The Engine configuration (`engine.yaml`) location varies based on installation method: | ||
| - **Homebrew**: `$HOMEBREW_REPOSITORY/etc/arcade-engine/engine.yaml` (commonly `/opt/homebrew/Cellar/etc/arcade-engine/engine.yaml`) | ||
| - **Apt**: `/etc/arcade-ai/engine.yaml` | ||
| - **Manual Download**: Manually downloaded configs can be added to `$HOME/.arcade/engine.yaml` | ||
|
|
||
| <Note>To manually download the engine.yaml, you can get an example from the [Configuration Templates](/home/configure/templates#engineyaml)</Note> | ||
|
|
||
| Engine configurations support variable expansion for [Secrets](/home/configure/engine#secrets) and [Environment Files](/home/configure/engine#dotenv-files). | ||
|
|
||
| You can edit the `engine.yaml` file to change configurations for the [Engine](/home/configure/engine) and [Supported Models](/home/configure/models). | ||
|
|
||
| ### Engine environment file | ||
|
|
||
| The Engine environment file (`engine.env`) location varies based on installation method: | ||
| - **Homebrew**: `$HOMEBREW_REPOSITORY/etc/arcade-engine/engine.env` (commonly `/opt/homebrew/etc/arcade-engine/engine.env`) | ||
| - **Apt**: `/etc/arcade-ai/engine.env` | ||
| - **Manual Download**: Manually downloaded configs can be added to `$HOME/.arcade/engine.env` | ||
|
|
||
| <Note>To manually download the engine.env, you can get an example from the [Configuration Templates](/home/configure/templates#engineenv)</Note> | ||
|
|
||
|
|
||
| The installed file contains default variables to run the Engine locally, and can be changed or | ||
| overridden by exporting variables to your environment through the command line. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,12 +6,12 @@ description: "Arcade Engine Configuration Templates" | |
|
|
||
| # Engine Config Templates | ||
|
|
||
| **engine.yaml** | ||
| ### engine.yaml | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. makes it so that i can link to this from other pages |
||
| ```yaml file=<rootDir>/examples/code/home/configuration/engine/config_template.1.0.yaml | ||
|
|
||
| ``` | ||
|
|
||
| **engine.env** | ||
| ### engine.env | ||
| ```bash file=<rootDir>/examples/code/home/configuration/engine/engine.env | ||
|
|
||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ import styles from "./TableOfContents.module.css"; | |
| function TableOfContents({ headers, data }) { | ||
| const handleRowClick = (firstColumnValue) => { | ||
| // Convert first column value to a valid ID format | ||
| const sectionId = firstColumnValue.toLowerCase().replace(/\s+/g, ""); | ||
| const sectionId = firstColumnValue.toLowerCase().replace(/\s+/g, "-"); | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. so that table of contents section names can have spaces and still be linked to a specific section on the page |
||
| // Update the URL hash to navigate to the section | ||
| window.location.hash = `#${sectionId}`; | ||
| }; | ||
|
|
||


There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before:

After:

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is probably outside of this PR, but I think we should indicate that these rows are links somehow, not just a table.