> For the complete documentation index, see [llms.txt](https://docs.visdom.virtuslab.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.visdom.virtuslab.com/onboarding-for-new-users.md).

# Onboarding for new users

Do you have a project which you would like to integrate with Visdom? Great! Below you can find a quick list of things to look at to get started. If you are new to Visdom, [Products and packages](/products-and-packages.md) explains what each product does.

## Installing GitHub app

In order to let Visdom integrate with your repositories you need to install the [Visdom Orchestrator GitHub app](https://github.com/apps/visdomorchestrator) in your GitHub repositories.

1. Open the [installation page](https://github.com/apps/visdomorchestrator/installations/select_target?page=1) and pick the organisation or personal account that owns your repositories.
2. Choose **Only select repositories**, select the repositories you want to use with Visdom, and confirm with **Install**.
3. Note the **installation ID**: the number at the end of the installation's settings address, `github.com/organizations/<org>/settings/installations/<ID>`. Visdom administrators need it when they add your repositories to your project.

Installing an app in an organisation requires owner rights; otherwise GitHub sends an approval request to the owners. See GitHub's guide [Installing a GitHub App from a third party](https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-a-third-party).

## Ask for Visdom project creation

In order to start integrating your project with Visdom we need to create a [Visdom project](https://docs.visdom.virtuslab.com/visdom-control-plane/using-the-control-plane/projects-and-repositories) for you. Currently that's being done by Visdom administrators. Please reach out to us on Slack channel [project-visdom-dev](https://softwaremill.slack.com/archives/C0AUYMUCQ9L) and ask for a new project creation. Please provide:

* a suitable name, unique for your work,
* the URLs of the repositories to add to the project,
* the GitHub App installation ID from the previous step.

The administrators will [create the project](https://docs.visdom.virtuslab.com/visdom-control-plane/using-the-control-plane/projects-and-repositories#create-a-project) and [add your repositories](https://docs.visdom.virtuslab.com/visdom-control-plane/using-the-control-plane/projects-and-repositories#add-a-repository) to it.

## Create your Visdom user

In order to use Visdom you need to have a Visdom user. Users are being created automatically during the first log in attempt. Please log in with your **google virtuslab domain account** in one of Visdom services, for example [Orchestrator](https://orchestrator.visdom.virtuslab.com/orchestrator/dashboard).

Once your user is created then Visdom administrators can add you to the project and provide your user with all necessary permissions for your work in Visdom. Access is deny by default, so until then you will see *Access not granted*. See [Users and access](https://docs.visdom.virtuslab.com/visdom-control-plane/using-the-control-plane/users-and-access) for how access is granted, and [The permission model](https://docs.visdom.virtuslab.com/visdom-control-plane/permissions/permission-model) for what the roles mean.

## What's next

* **Orchestrator**: start with the [User Guide](https://docs.visdom.virtuslab.com/visdom-orchestrator/user-guide), then [Concepts and the object model](https://docs.visdom.virtuslab.com/visdom-orchestrator/user-guide/concepts-and-the-object-model), [The catalog: install, fork, upgrade](https://docs.visdom.virtuslab.com/visdom-orchestrator/user-guide/the-catalog-install-fork-upgrade) and [Configuring an agent](https://docs.visdom.virtuslab.com/visdom-orchestrator/user-guide/configuring-an-agent).
* **Context Fabric**: [Setting up a project](https://docs.visdom.virtuslab.com/visdom-context-fabric/user-guide/setting-up-a-project) and [Using Context Fabric with the Orchestrator](https://docs.visdom.virtuslab.com/visdom-context-fabric/user-guide/using-context-fabric-with-the-orchestrator).
* **AI Tracing**: [Installing the CLI and signing in](https://docs.visdom.virtuslab.com/visdom-tracing/user-guide/installing-tracevault-and-signing-in).
