Merge branch 'develop' into docs/contributor-meetings

.env.example

@@ -968,6 +968,14 @@ BUNDLE_EXECUTOR_ADDRESS=          # Address of the bundle executor contract
 DESK_EXCHANGE_PRIVATE_KEY=                  # Required for trading and cancelling orders
 DESK_EXCHANGE_NETWORK=                      # "mainnet" or "testnet
 
+
+# Compass plugin configuration
+COMPASS_WALLET_PRIVATE_KEY=
+COMPASS_ARBITRUM_RPC_URL=
+COMPASS_ETHEREUM_RPC_URL=
+COMPASS_BASE_RPC_URL=
+
 # d.a.t.a Plugin Configurations
 DATA_API_KEY=           # Your d.a.t.a API key
 DATA_AUTH_TOKEN=       # Your d.a.t.a auth token
+

docs/docs/guides/remote-deployment.md

@@ -0,0 +1,249 @@
+---
+sidebar_position: 13
+---
+# Deploying ElizaOS to Production
+
+A guide to deploying and maintaining an [ElizaOS](https://github.com/elizaOS/eliza) agent in a production environment.
+
+## Assumptions
+
+- Freshly installed Ubuntu 22.04 LTS
+- RAM >= 4GB
+- Disk space >= 20GB
+- You have a user, not root, with sudo access that can ssh into the server
+
+## Basic System Setup
+
+A slightly opinionated list of tools that we need to install.
+
+```bash
+sudo apt update
+sudo apt -y upgrade
+sudo apt -y install \
+    neovim \
+    curl \
+    git \
+    unzip \
+    zip \
+    ntp \
+    ufw \
+    python3 \
+    python3-pip
+```
+
+Configure and enable firewall.
+
+```bash
+sudo ufw default deny incoming
+sudo ufw default allow outgoing
+sudo ufw allow 22/tcp
+```
+
+If you want to publicly expose the API, you can do so with:
+```bash
+sudo ufw allow 3000/tcp
+```
+
+Enable the firewall.
+
+```bash
+sudo ufw --force enable
+```
+
+Note: For a Discord bot, no additional ports need to be opened. The bot makes outbound connections to Discord's servers which are allowed by default.
+
+### Locale
+
+The following ensures that your agent's date and time matches yours. Adjust to suit.
+
+```bash
+sudo timedatectl set-timezone Europe/London
+sudo locale-gen en_GB.UTF-8 > /dev/null
+sudo update-locale LANG=en_GB.UTF-8
+```
+
+### Service user
+
+Create a system user called `eliza` with a home directory of `/opt/elizaos`.
+
+```bash
+sudo useradd -r -s /bin/bash -d /opt/elizaos -m eliza
+sudo chown -R eliza:eliza /opt/elizaos
+sudo chmod 750 /opt/elizaos
+```
+
+## Install dependencies and configure the agent
+
+Switch to the `eliza` user and clone the repository. 
+
+```bash
+sudo su - eliza # this puts you in /opt/elizaos
+
+git clone https://github.com/elizaOS/eliza.git
+```
+
+Switch to the latest release branch.
+```bash
+cd eliza
+git checkout $(git describe --tags --abbrev=0)
+```
+
+You can see which release you're on using `git status`.
+
+```bash
+eliza@parzival:~$ git status
+HEAD detached at v0.25.6-alpha.1
+```
+
+Install nvm.
+
+```bash
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+export NVM_DIR="$HOME/.nvm"
+. "$NVM_DIR/nvm.sh"
+```
+
+Install the correct version of Node.js using nvm.
+```bash
+nvm install v23.3.0
+nvm use v23.3.0
+```
+
+Install pnpm globally and verify the installation:
+```bash
+# Install pnpm
+npm install -g pnpm
+pnpm setup
+source ~/.bashrc
+
+# Verify pnpm installation and path
+which pnpm
+# Should output something like: /opt/elizaos/.local/share/pnpm/pnpm
+```
+
+Install and build the workspace.
+```bash
+pnpm install --no-frozen-lockfile
+pnpm build
+```
+
+### Configure Environment
+```bash
+# Copy example environment file
+cp -v .env.example .env
+```
+Make changes to the `.env` file for your production environment as required. 
+
+For example, your `.env` might look like this for a simple Discord bot:
+```bash
+USE_CHARACTER_STORAGE=true
+
+# Discord Configuration
+DISCORD_APPLICATION_ID=...
+DISCORD_API_TOKEN=...
+
+# AI Provider Keys
+OPENAI_API_KEY=sk-...
+ANTHROPIC_API_KEY=sk-...
+```
+
+Setup a default character and storage for the character's state.
+```bash
+cd characters
+ln -svf snoop.character.json default.character.json
+cd ..
+mkdir -p data/memory/default
+chmod 750 data
+```
+
+### Shell Environment Setup
+
+We need to properly configure the shell environment for the `eliza` user so nvm/pnpm works:
+
+```bash
+sudo tee /opt/elizaos/.profile << 'EOL'
+# NVM setup
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+
+# pnpm setup
+export PNPM_HOME="$HOME/.local/share/pnpm"
+case ":$PATH:" in
+  *":$PNPM_HOME:"*) ;;
+  *) export PATH="$PNPM_HOME:$PATH" ;;
+esac
+EOL
+```
+
+Set ownership of the profile file.
+
+```bash
+sudo chown eliza:eliza /opt/elizaos/.profile
+```
+
+### `systemd` Service
+
+To enable eliza to start automatically on boot, we need to create a systemd service.
+
+Logout as `eliza` using `CTRL-D`, which should drop you 
+back into your user with sudo access.
+
+Create the systemd service file:
+
+```bash
+sudo tee /etc/systemd/system/eliza.service << 'EOL'
+[Unit]
+Description=Eliza AI Chat Agent
+After=network.target
+
+[Service]
+Type=simple
+User=eliza
+WorkingDirectory=/opt/elizaos/eliza
+
+# Environment setup
+Environment=NODE_ENV=production
+Environment=HOME=/opt/elizaos
+Environment=HTTP_PORT=3000
+Environment=PATH=/opt/elizaos/.local/share/pnpm:/usr/local/bin:/usr/bin:/bin
+Environment=NVM_DIR=/opt/elizaos/.nvm
+
+# Source NVM and start app
+ExecStart=/bin/bash -c '. $NVM_DIR/nvm.sh && exec pnpm start --characters="characters/default.character.json"'
+
+# Logging
+StandardOutput=append:/var/log/eliza/eliza.log
+StandardError=append:/var/log/eliza/eliza-error.log
+
+# Restart configuration
+Restart=always
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOL
+```
+
+Create the log directory.
+```bash
+sudo mkdir -p /var/log/eliza
+sudo chown -R eliza:eliza /var/log/eliza
+```
+
+Enable and start the service:
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable eliza
+sudo systemctl start eliza
+```
+
+The API should now be running on port 3000. Note that external access to this port is blocked by default unless you explicitly allowed it in the firewall configuration during basic system setup.
+
+If you need to troubleshoot, you can:
+```bash
+# Check service status
+sudo systemctl status eliza
+
+# View service logs with journald
+sudo journalctl -u eliza -f
+```

i18n/readme/README_KOR.md

@@ -13,7 +13,7 @@
 ## 🚩 구조
 
 <div align="center">
-  <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
+  <img src="/docs/static/img/eliza_diagram.png" alt="Eliza Diagram" width="100%" />
 </div>
 
 ## ✨ 기능