Documentation Index
Fetch the complete documentation index at: https://oxy.tech/docs/llms.txt
Use this file to discover all available pages before exploring further.
After setting up the server infrastructure, you need to create or copy your Oxy workspace directory and configure your repository.
Create Workspace Directory
Create a directory for your Oxy workspace on the server:mkdir -p ~/oxy-workspace
cd ~/oxy-workspace
Configure Repository
Depending on your setup, you can either use Git to manage your Oxy files or manually set up your workspace.If you’re using Git to manage your workspace:
- Install Git and configure credentials:
apt-get update && apt-get install -y git
- Set up SSH keys for Git access:
# Generate SSH key
ssh-keygen -t ed25519 -C "your-email@example.com"
# Add GitHub to known hosts
ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
# Print public key to add to GitHub
cat ~/.ssh/id_ed25519.pub
-
Add the public key to your GitHub account settings.
-
Clone your Oxy repository:
git clone git@github.com:your-org/your-oxy-repo.git
cd your-oxy-repo
If you’re not using Git:
- Manually copy your workspace files to the server using tools like SCP or SFTP:
# Example: Using scp to copy files from local to server
# Run this command from your local machine
scp -r /path/to/local/oxy-project user@server:/path/on/server
- Navigate to your workspace directory:
cd /path/on/server/oxy-project
Verify Workspace Structure
Ensure your workspace has the necessary structure and files:# List files in your workspace
ls -la
# Check if you have a config.yml file
if [ -f "config.yml" ]; then
echo "Config file found"
else
echo "Config file missing"
fi
config.yml - Main configuration file- Agent definitions (
.agent.yml files)
- Workflow definitions (
.workflow.yml files)
- SQL queries (
.sql files)
- Semantic models (
.schema.yml files)
Update systemd Service Configuration
If you’ve already set up Oxy as a systemd service, update the service file to point to your actual workspace path:sudo sed -i "s|/home/ubuntu/your-oxy-project|$(pwd)|g" /etc/systemd/system/oxy.service
sudo systemctl daemon-reload
