# Reviactyl Docs

## Home

- [Help Center](https://docs.reviactyl.app/readme.md)
- [Getting started checklist](https://docs.reviactyl.app/getting-started/getting-started-checklist.md): Everything you need to do to go from sign-up to a published site.
- [What's the difference between a workspace and a project?](https://docs.reviactyl.app/getting-started/whats-the-difference-between-a-workspace-and-a-project.md): Understand the difference between workspaces and projects, and when to use each.
- [Setting up a custom domain](https://docs.reviactyl.app/getting-started/setting-up-a-custom-domain.md): Point your own domain or subdomain at your published site.
- [How do I change my plan?](https://docs.reviactyl.app/plans-billing/how-do-i-change-my-plan.md): Upgrade, downgrade, or switch between billing cycles at any time.
- [Billing FAQ](https://docs.reviactyl.app/plans-billing/billing-faq.md): Answers to the most common billing questions.
- [Inviting team members to your workspace](https://docs.reviactyl.app/admin/inviting-team-members-to-your-workspace.md): Add team members to your workspace and assign them the right roles.
- [SSO configuration guide](https://docs.reviactyl.app/admin/sso-configuration-guide.md): Configure single sign-on so your team can log in with your existing identity provider.
- [Managing API keys](https://docs.reviactyl.app/admin/managing-api-keys.md): Manage API keys and monitor usage across your workspace.
- [Connecting a third-party app](https://docs.reviactyl.app/integrations/connecting-a-third-party-app.md): Connect external tools to bring your content and workflows together.
- [Why isn't my integration syncing?](https://docs.reviactyl.app/integrations/why-isnt-my-integration-syncing.md): Common reasons your integration stops syncing, and how to fix them.
- [API rate limits and quotas](https://docs.reviactyl.app/integrations/api-rate-limits-and-quotas.md): Understand the API rate limits that apply to your plan, and what to do if you hit them.
- [Contributing to the platform](https://docs.reviactyl.app/community/contributing-to-the-platform.md): Help improve the platform by contributing feedback, bug reports, and ideas.

## Project

- [Introduction](https://docs.reviactyl.app/project/introduction.md)
- [Community Standards](https://docs.reviactyl.app/project/community-standards.md)
- [Terminology](https://docs.reviactyl.app/project/terminology.md)
- [Release Cycle](https://docs.reviactyl.app/project/release-cycle.md)
- [Getting Started](https://docs.reviactyl.app/project/panel/getting-started.md)
- [Updating the Panel](https://docs.reviactyl.app/project/panel/updating-the-panel.md)
- [Migrating from Pterodactyl](https://docs.reviactyl.app/project/panel/migrating-from-pterodactyl.md)
- [Upgrading from v2](https://docs.reviactyl.app/project/panel/upgrading-from-v2.md)
- [Additional Configuration](https://docs.reviactyl.app/project/panel/additional-configuration.md)
- [Webserver Configuration](https://docs.reviactyl.app/project/panel/webserver-configuration.md)
- [Installing Agent](https://docs.reviactyl.app/project/agent/installing-agent.md)
- [Updating Agent](https://docs.reviactyl.app/project/agent/updating-agent.md)
- [Additional Configuration](https://docs.reviactyl.app/project/agent/additional-configuration.md)
- [Migrating From Wings](https://docs.reviactyl.app/project/agent/migrating-from-wings.md)
- [Installing Docker](https://docs.reviactyl.app/project/tutorial/installing-docker.md)
- [Creating SSL Certificates](https://docs.reviactyl.app/project/tutorial/creating-ssl-certificates.md)
- [MySQL Setup](https://docs.reviactyl.app/project/tutorial/mysql-setup.md)
- [Panel in Docker](https://docs.reviactyl.app/project/tutorial/panel-in-docker.md)
- [Troubleshooting](https://docs.reviactyl.app/project/tutorial/troubleshooting.md)
- [Upgrading PHP](https://docs.reviactyl.app/project/tutorial/upgrading-php.md)

## Development

- [Introduction](https://docs.reviactyl.app/development/introduction.md): Introduction to Development
- [Getting Started](https://docs.reviactyl.app/development/extensions/getting-started.md): Getting Started with Reviactyl Extensions
- [Building Extensions](https://docs.reviactyl.app/development/extensions/building-extensions.md): Building Reviactyl Extensions
- [Frontend Development](https://docs.reviactyl.app/development/extensions/frontend-development.md): Inject UI Elements into your Panel
- [Backend Development](https://docs.reviactyl.app/development/extensions/backend-development.md): Injecting Routes, Controllers, and Hooks.
- [Packaging Extension](https://docs.reviactyl.app/development/extensions/packaging-extension.md): Package and Compile your Extension
- [Publishing Extension](https://docs.reviactyl.app/development/extensions/publishing-extension.md): Publish your Extension to our Marketplace
- [Creating Custom Eggs](https://docs.reviactyl.app/development/eggs/creating-custom-eggs.md): Guide to Create Eggs in Reviactyl
- [Creating a Custom Docker Image](https://docs.reviactyl.app/development/eggs/creating-a-custom-docker-image.md): Creating Docker Image for Reviactyl
- [Building Panel](https://docs.reviactyl.app/development/customization/building-panel.md): Steps to Build Reviactyl Panel
- [Building Agent](https://docs.reviactyl.app/development/customization/building-agent.md): Steps to Build Reviactyl Agent (GO)

## Client API

- [API Documentation](https://docs.reviactyl.app/client-api/api-documentation.md)
- [Client API Impersonation](https://docs.reviactyl.app/client-api/impersonation.md): Client API impersonation lets an authorized application API key make a request as a particular panel user.
- [Account](https://docs.reviactyl.app/client-api/account.md)
- [Activity Log](https://docs.reviactyl.app/client-api/activity-log.md)
- [Alert](https://docs.reviactyl.app/client-api/alert.md)
- [Api Key](https://docs.reviactyl.app/client-api/api-key.md)
- [Backup](https://docs.reviactyl.app/client-api/backup.md)
- [Category](https://docs.reviactyl.app/client-api/category.md)
- [Client](https://docs.reviactyl.app/client-api/client.md)
- [Command](https://docs.reviactyl.app/client-api/command.md)
- [Database](https://docs.reviactyl.app/client-api/database.md)
- [Extensions](https://docs.reviactyl.app/client-api/extensions.md)
- [File](https://docs.reviactyl.app/client-api/file.md)
- [File Upload](https://docs.reviactyl.app/client-api/file-upload.md)
- [Network Allocation](https://docs.reviactyl.app/client-api/network-allocation.md)
- [Passkey](https://docs.reviactyl.app/client-api/passkey.md)
- [Power](https://docs.reviactyl.app/client-api/power.md)
- [Resource History](https://docs.reviactyl.app/client-api/resource-history.md)
- [Resource Utilization](https://docs.reviactyl.app/client-api/resource-utilization.md)
- [SSHKey](https://docs.reviactyl.app/client-api/sshkey.md)
- [Schedule](https://docs.reviactyl.app/client-api/schedule.md)
- [Schedule Task](https://docs.reviactyl.app/client-api/schedule-task.md)
- [Server](https://docs.reviactyl.app/client-api/server.md)
- [Settings](https://docs.reviactyl.app/client-api/settings.md)
- [Social Login](https://docs.reviactyl.app/client-api/social-login.md)
- [Startup](https://docs.reviactyl.app/client-api/startup.md)
- [Subuser](https://docs.reviactyl.app/client-api/subuser.md)
- [Subuser Preview](https://docs.reviactyl.app/client-api/subuser-preview.md)
- [Two Factor](https://docs.reviactyl.app/client-api/two-factor.md)
- [Websocket](https://docs.reviactyl.app/client-api/websocket.md)
- [Models](https://docs.reviactyl.app/client-api/models.md)

## Application API

- [API Documentation](https://docs.reviactyl.app/application-api/api-documentation.md)
- [Allocation](https://docs.reviactyl.app/application-api/allocation.md)
- [Database](https://docs.reviactyl.app/application-api/database.md)
- [Egg](https://docs.reviactyl.app/application-api/egg.md)
- [External Server](https://docs.reviactyl.app/application-api/external-server.md)
- [External User](https://docs.reviactyl.app/application-api/external-user.md)
- [Location](https://docs.reviactyl.app/application-api/location.md)
- [Nest](https://docs.reviactyl.app/application-api/nest.md)
- [Node](https://docs.reviactyl.app/application-api/node.md)
- [Node Configuration](https://docs.reviactyl.app/application-api/node-configuration.md)
- [Node Deployment](https://docs.reviactyl.app/application-api/node-deployment.md)
- [Server](https://docs.reviactyl.app/application-api/server.md)
- [Server Details](https://docs.reviactyl.app/application-api/server-details.md)
- [Server Management](https://docs.reviactyl.app/application-api/server-management.md)
- [Startup](https://docs.reviactyl.app/application-api/startup.md)
- [User](https://docs.reviactyl.app/application-api/user.md)
- [Models](https://docs.reviactyl.app/application-api/models.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.reviactyl.app/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
