Up and Running in 10 Minutes

Choose your integration, install Docker, and start asking questions.

Prerequisites

  • Docker and Docker Compose installed on your machine
  • Maximo API URL (your OSLC endpoint, e.g. https://your-server/maximo/oslc for MAS or http://server:port/maxrest/oslc/os for 7.6)
  • Maximo API key (MAS 8.x/9.x) or admin username & password (Maximo 7.6 MAXAUTH)

No LLM API key required — the setup wizard offers a free AI backend out of the box.

Step 1

Create docker-compose.yml

Create a file called docker-compose.yml in an empty directory.

services:
  interpretos-local:
    image: interpretos/local:latest
    ports:
      - "8080:5000"
    volumes:
      - interpretos-data:/app/data
    restart: unless-stopped

volumes:
  interpretos-data:

That's it — no environment variables needed. The setup wizard handles all configuration in your browser.

Step 2

Start the Container

docker compose up -d
Step 3

Complete the Setup Wizard

Open http://localhost:8080 in your browser. On first launch, a setup wizard walks you through five steps:

1. Admin Account Set your admin username and password
2. AI Provider Free tier pre-selected — or bring your own key
3. Telemetry Opt in or out of anonymous usage metrics
4. Database Connection Skip this step for Maximo (API-based, not database)
5. Review & Launch Confirm settings and start chatting

After setup, go to Admin Panel > Credentials to enter your Maximo API URL and credentials. Both MAS API keys and Maximo 7.6 MAXAUTH (username/password) are supported.

Step 4

Ask Your First Question

Select Maximo from the integration selector, then try a query against your live data.

Try this
"What is the status of work order 1001?"

Prerequisites

  • Docker and Docker Compose installed on your machine
  • SSH access to your EBS database server (key-based authentication)
  • APPS database credentials (read-only SQL access is sufficient)
  • Your SSH private key file (you'll paste it into the setup wizard)

No LLM API key required — the setup wizard offers a free AI backend out of the box.

Step 1

Create docker-compose.yml

Create a file called docker-compose.yml in an empty directory.

services:
  interpretos-local:
    image: interpretos/local:latest
    ports:
      - "8080:5000"
    volumes:
      - interpretos-data:/app/data
    restart: unless-stopped

volumes:
  interpretos-data:

That's it — no environment variables needed. The setup wizard handles all configuration in your browser.

Step 2

Start the Container

docker compose up -d
Step 3

Complete the Setup Wizard

Open http://localhost:8080 in your browser. On first launch, a setup wizard walks you through five steps:

1. Admin Account Set your admin username and password
2. AI Provider Free tier pre-selected — or bring your own key
3. Telemetry Opt in or out of anonymous usage metrics
4. Database Connection Enter SSH host, paste your private key, and provide Oracle credentials. Test the connection before proceeding.
5. Review & Launch Confirm settings and start chatting
Step 4

Set Up Users (Optional)

For row-level security, go to Admin Panel > Users to create user accounts, then Admin Panel > Credentials to map each user to their EBS username. Users will log in with their own EBS password for RBAC enforcement.

Step 5

Ask Your First Question

Select Oracle EBS from the integration selector, then try a query against your live data.

Try this
"Show me purchase order details for PO 4281"

Prerequisites

  • Docker and Docker Compose installed on your machine
  • SSH access to your PeopleSoft database server (key-based authentication)
  • SYSADM database credentials (read-only SQL access is sufficient)
  • Your SSH private key file (you'll paste it into the setup wizard)

No LLM API key required — the setup wizard offers a free AI backend out of the box.

Step 1

Create docker-compose.yml

Create a file called docker-compose.yml in an empty directory.

services:
  interpretos-local:
    image: interpretos/local:latest
    ports:
      - "8080:5000"
    volumes:
      - interpretos-data:/app/data
    restart: unless-stopped

volumes:
  interpretos-data:

That's it — no environment variables needed. The setup wizard handles all configuration in your browser.

Step 2

Start the Container

docker compose up -d
Step 3

Complete the Setup Wizard

Open http://localhost:8080 in your browser. On first launch, a setup wizard walks you through five steps:

1. Admin Account Set your admin username and password
2. AI Provider Free tier pre-selected — or bring your own key
3. Telemetry Opt in or out of anonymous usage metrics
4. Database Connection Enter SSH host, paste your private key, and provide Oracle credentials. Test the connection before proceeding.
5. Review & Launch Confirm settings and start chatting
Step 4

Set Up Users (Optional)

For row-level security, go to Admin Panel > Users to create user accounts, then Admin Panel > Credentials to map each user to their PeopleSoft operator ID. RBAC is enforced automatically based on the user's department security profile.

Step 5

Ask Your First Question

Select PeopleSoft from the integration selector, then try a query against your live data.

Try this
"Who is employee KU0001?"

Don't Have an LLM API Key?

Use Interpretos Cloud to skip LLM configuration entirely. Free tier included.

Free AI Backend — No API Key Required

The setup wizard offers Interpretos Cloud (Free) as the default AI provider. Select it during step 2 and start asking questions immediately — no external account needed.

Want your own API key? Register for free with just your email. Or bring your own key from Google Gemini, OpenAI, Azure, or Anthropic.

Troubleshooting

Common issues and how to resolve them.

Container won't start

Verify that Docker is running on your machine. Check that port 8080 is not already in use by another application. You can change the port mapping in your docker-compose.yml if needed (e.g., "9090:8080").

Can't connect to Maximo

Double-check your API_BASE URL — for MAS it should end with /maximo/api/os, for Maximo 7.6 use /maxrest/oslc/os. Verify your API key (MAS) or MAXAUTH credentials (7.6) are correct and have read access. Ensure your machine can reach the Maximo server (check firewalls, VPN requirements).

Can't connect to Oracle EBS

Test SSH access manually first: ssh -i ~/.ssh/id_rsa root@your-ebs-server. Verify that the SSH key file has correct permissions (chmod 600 ~/.ssh/id_rsa). Ensure sqlplus is available on the remote server.

Can't connect to PeopleSoft

Test SSH access manually first: ssh -i ~/.ssh/id_rsa oracle2@your-peoplesoft-server. Verify that the SSH key file has correct permissions (chmod 600 ~/.ssh/id_rsa). Ensure sqlplus is available on the remote server and the PDB (e.g., HCMVRS) is open.

Slow responses

The first query after startup takes longer while the system initializes. Subsequent queries will be significantly faster. For Maximo, typical response times are under 15 seconds. For EBS (SSH + sqlplus), expect 11-17 seconds per query due to connection overhead.

Forgot admin password

Reset any user's password from the server with a single command. This requires Docker access on the host machine.

docker exec interpretos-local python /app/reset-password.py

This resets the admin account to the default password (admin). You'll be prompted to set a new password on next login. To reset a different user or set a specific password:

docker exec interpretos-local python /app/reset-password.py <username> <new-password>

Updating to the Latest Version

All your settings, users, credentials, and audit history are preserved across updates.

Step 1

Pull the Latest Image

In the directory containing your docker-compose.yml:

docker compose pull
Step 2

Restart the Container

docker compose up -d

Docker will recreate the container with the new version. The data volume is untouched — your configuration, users, and credentials carry over automatically.

Step 3

Verify the Update

Open Admin Panel > Updates to confirm the new version number. You can also check from the command line:

curl -s http://localhost:8080/api/version

Checking for Updates

Interpretos Local checks for new versions automatically. Go to Admin Panel > Updates and click Check Now to see if a newer version is available. When an update is available, the panel shows the new version number and the Docker pull command.

What's Next?

Explore what Interpretos can do for your specific enterprise system.