======================================================
Dockstore GitHub App
======================================================

GitHub apps are a GitHub feature used to improve the interaction between external applications and GitHub.
Users can grant a GitHub app access to repositories in an organization and/or personal account of their choosing.

The Dockstore GitHub App adds support for registering and automatically syncing your files between Dockstore and GitHub. It is our preferred method for registration, so you can find a breakdown of that process on the respective pages for :doc:`tool registration </getting-started/dockstore-tools>`, :doc:`workflow registration </getting-started/dockstore-workflows>`, :doc:`service registration </getting-started/getting-started-with-services>`, and :doc:`notebook registration </getting-started/getting-started-with-notebooks>`.

Check out the following guides to learn more:

- Start here first! --> :doc:`github-apps`
- :doc:`Installing the GitHub App </getting-started/github-apps/snippet--installation>`
- :doc:`github-apps-troubleshooting-tips`
- :doc:`Template/Example .dockstore.yml files </assets/templates/template>`
- Already registered a tool or workflow on Dockstore, but want to transfer it to GitHub Apps registration for automatically sync?
  - :doc:`Migrating Legacy Workflows to use the GitHub App <migrating-workflows-to-github-apps>`
  - :doc:`Migrating Legacy Tools to use the GitHub App <migrating-tools-to-github-apps>`

.. toctree::
    :hidden:

    github-apps
    Installing the GitHub App </getting-started/github-apps/snippet--installation>
    Troubleshooting and FAQ <github-apps-troubleshooting-tips>
    .dockstore.yml Examples </assets/templates/template>
    Migrating Legacy Workflows <migrating-workflows-to-github-apps>
    Migrating Legacy Tools <migrating-tools-to-github-apps>