Authentication
How to authenticate with the OutRay CLI
Before you can start a tunnel, you need to authenticate with your OutRay account. This ensures that your tunnels are secure and associated with your user profile.
Interactive Login
The easiest way to authenticate is using the interactive login command. Run the following command in your terminal:
outray loginThis command will:
- Open your default web browser to the OutRay dashboard.
- Ask you to authorize the CLI.
- Once authorized, the CLI will automatically receive an authentication token and save it locally.
API Key Login
For environments where you cannot use a browser (like a remote server or CI/CD pipeline), you can authenticate using an API key.
- Go to your Organization Settings in the dashboard.
- Generate a new API Key.
- Use the
--keyflag when running commands:
outray 3000 --key outray_sk_...Checking Status
To verify that you are logged in and see which user/organization is active, run:
outray whoami