Start here

Getting Started with Gentility

1) Create your organization

Sign up or log in to the Gentility Console and create an organization.

Pick your setup flow

Decide which resources you’re exposing. The buttons jump to the relevant steps below.

Server-only shell access

Install the Gentility agent and stop there. Perfect for ephemeral shells or file operations.

Go to agent install
Database target via direct IP

Connect a database reachable from Gentility over the public internet or VPN. No agent required.

Add DB (direct)
Database routed through your server

Install the agent, create a portal, and expose internal databases through it.

Add DB via portal

2) Install the on‑server agent

Run the installer on Ubuntu/Debian and register the agent with your organization. The agent provides ephemeral and persistent shells, plus safe database access.

Option 1: APT Repository (Recommended)
                  # Add GPG key
sudo mkdir -p /etc/apt/keyrings
curl -s https://packages.gentility.ai/gentility-packages.gpg  | sudo tee /etc/apt/keyrings/gentility-packages.asc > /dev/null

# Add repository
echo "deb [signed-by=/etc/apt/keyrings/gentility-packages.asc] https://packages.gentility.ai/debian/ stable main" | sudo tee /etc/apt/sources.list.d/gentility.list

# Install agent
sudo apt update
sudo apt install gentility-agent
                
Option 2: Direct DEB Package
                  # Download latest package
wget https://github.com/gentility-ai/agent/releases/download/v1.0.32/gentility-agent_1.0.32_amd64.deb


# Install package
sudo dpkg -i gentility-agent_1.0.32_amd64.deb
sudo apt-get install -f
                
Setup & Configuration
                  # Initial setup (requires access token)
sudo gentility setup YOUR_TOKEN_HERE

# Start the agent
gentility run
                

3) Add a database target (direct)

In the Console, go to Data Sources → Add Target. Start with read‑only to validate policies and visibility. You can later enable guarded writes.

Feel free to test with our read-only demo databases:

PostgreSQL demo
postgresql://readonly:[email protected]:5432/ecommerce_demo
SQL Server demo
mssql://readonly:[email protected]:1433/ecommerce_demo
Gentility Console databases list showing a connected ecommerce demo target
Console databases view — add new targets from here and confirm their connection status.
New database target form in Gentility prefilled with the demo PostgreSQL URL
For direct mode, paste the connection string, hit Parse, and run the connection test before saving.

4) Add a database via your agent

When a database is only reachable from inside your network, use the portal created during the agent install. Pick Agent (Portal) as the connection mode and supply the internal host/port.

  • Confirm the agent is online under Portals and note the portal name.
  • In the new DB target form, choose the portal under Connection Mode → Agent and keep read-only enabled for testing.
  • Test the connection. The agent proxies traffic through your portal; success indicates the internal host is reachable.

Need deeper instructions? Follow the dedicated guides for installing the agent and adding database targets.

6) Verify safety and audit trails

Run a safe query and confirm the policy decision, logs, and any artifacts are recorded. Try a blocked write to see the denial response and audit entry.

# Example blocked command
rm -rf /   # → Denied by policy

# Example blocked SQL
DROP TABLE users;   # → Denied by policy
Gentility denying a read-only database write request with explanation
Denied writes appear inline with clear reasoning — confirm policy and audit behavior before going live.
ChatGPT is a trademark of OpenAI. Claude is a trademark of Anthropic PBC. All other marks are the property of their respective owners.