Browse authenticated pages with a sandbox
A sandbox gives Docs Agent a site URL and the sign-in variables it needs to reach pages behind a login. With a sandbox configured, the agent can open your product, sign in, and capture screenshots of authenticated pages to include in your documentation. Without one, the agent can browse only pages that don’t require signing in.
Prerequisites
Section titled “Prerequisites”- An EkLine organization account.
- The Sandbox tab under Settings > Docs Agent. If you don’t see it, see The Sandbox tab isn’t available.
- The URL of the site you want the agent to browse, and a set of sign-in credentials for it.
Create a sandbox
Section titled “Create a sandbox”-
Open your Docs Agent settings.
Go to your EkLine dashboard and open Settings > Docs Agent > Sandbox.
-
Name the sandbox.
In Sandbox name, enter a unique name such as
admin-staging. The name identifies the sandbox and can’t be changed later. To rename it, delete and recreate it. Two sandboxes can share a URL with different variables. -
Enter the site URL.
In Sandbox URL, enter the full URL, such as
https://staging.example.com. The agent applies this sandbox’s variables when it browses a page on this host. -
Add sign-in variables.
Each variable is a name and value pair. EkLine starts you with
emailandpasswordrows: enter the values the site needs to sign in. Values for variables named withpassword,secret,token, orkeyare masked as you type. Click Add variable to add more, such as an organization slug. Add at least one variable with a value. -
Save the sandbox.
Click Save sandbox. The sandbox appears under Configured sandboxes with its URL and a badge for each variable name.
Edit a sandbox
Section titled “Edit a sandbox”-
Open the sandbox.
In Configured sandboxes, click the edit icon next to the sandbox. A dialog opens with the current URL and variables filled in, titled Edit and the sandbox name, such as Edit admin-staging. The name is fixed.
-
Change the URL or variables.
Update the URL, edit values, or add and remove variables as needed.
-
Update the sandbox.
Click Update sandbox.
To keep a saved value without retyping it, such as a password, leave that variable’s value blank. EkLine keeps the value already stored. Enter a new value only when you want to replace it.
Delete a sandbox
Section titled “Delete a sandbox”In Configured sandboxes, click the delete icon next to the sandbox.
Use a sandbox in a session
Section titled “Use a sandbox in a session”Ask the agent to browse or screenshot a page on the sandbox’s host. The agent signs in with the sandbox variables, then captures the page. Watch it work in the Live browser panel.
Sign in to https://staging.example.com and add a screenshot of thebilling settings page to the "Manage billing" guide.Verify the sandbox
Section titled “Verify the sandbox”- The sandbox appears under Configured sandboxes with the correct URL and a badge for each variable.
- In a session, ask the agent to screenshot a page that requires signing in. In the Live browser panel, confirm the agent reaches the page as a signed-in user.
Troubleshooting
Section titled “Troubleshooting”The Sandbox tab isn’t available
Section titled “The Sandbox tab isn’t available”If Settings > Docs Agent has no Sandbox tab, contact support@ekline.io with your organization name.
The agent can’t sign in
Section titled “The agent can’t sign in”The credentials are wrong, or the sign-in form needs a value you didn’t add. Edit the sandbox, confirm each value is correct, and add any extra variable the login requires, such as an organization slug.
The agent browses but doesn’t sign in
Section titled “The agent browses but doesn’t sign in”The page host doesn’t match the sandbox URL. Confirm the host in Sandbox URL matches the page you asked the agent to open. A sandbox for staging.example.com doesn’t apply to app.example.com.
A saved value seems wrong after editing
Section titled “A saved value seems wrong after editing”You left the value blank while editing, which keeps the previous value. Enter the new value explicitly to replace it.
Next steps
Section titled “Next steps”- Watch the agent browse: see each page the agent visits in real time.
- Create documentation: Insert screenshots the agent captures into your docs.
- Keep documentation screenshots up to date: Recapture stale images from your live product on a schedule.
- Customize Docs Agent for your organization: Set conventions the agent applies to every session.
Stuck?
Section titled “Stuck?”Reply to your welcome email or contact support@ekline.io. We read every message.
Built on Potluck Docs, our open source template.