GitSwarm 2016.3-2 Documentation

---

Documentation

User documentation

• API Automate GitSwarm via a simple and powerful API.
• CI/CD GitLab CE Continuous Integration (CI) and Continuous Delivery (CD) getting started, .gitlab-ci.yml options, and examples.
• GitSwarm as OAuth2 authentication service provider. It allows you to login to other applications from GitSwarm.
• Container Registry Learn how to use GitLab CE Container Registry.
• GitSwarm Basics Find step-by-step how to start working on your commandline and on GitSwarm.
• Importing into GitSwarm.
• Importing and exporting projects between instances.
• Markdown GitSwarm's advanced formatting system.
• Migrating from SVN Convert a SVN repository to Git and GitSwarm
• Permissions Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
• Profile Settings
• Project Services Integrate a project with external services, such as CI and chat.
• Public access Learn how you can allow public and internal access to projects.
• SSH Setup your ssh keys and deploy keys for secure access to your projects.
• Webhooks Let GitSwarm notify you when new code has been pushed to your project.
• Workflow Using GitSwarm functionality and importing projects from GitHub and SVN.

Administrator documentation

• Access restrictions Define which Git access protocols can be used to talk to GitSwarm.
• Authentication/Authorization Configure external authentication with LDAP, SAML, CAS and additional Omniauth providers.
• Custom Git hooks Custom Git hooks (on the filesystem) for when webhooks aren't enough.
• Install Requirements, directory structures and installation from source.
• Restart GitSwarm Learn how to restart GitSwarm and its components.
• Integration How to integrate with systems such as JIRA, Redmine, Twitter.
• Issue closing Customize how to close an issue from commit messages.
• Libravatar Use Libravatar for user avatars.
• Log system Log system.
• Enable HTTPS Configure GitSwarm to use HTTPS.
• Environment Variables to configure GitSwarm.
• Operations Keeping GitSwarm up and running
• Raketasks Backups, maintenance, automatic webhook setup and the importing of projects.
• Repository checks Periodic Git repository checks.
• Repository storages Manage the paths used to store repositories.
• Security Learn what you can do to further secure your GitSwarm instance.
• System hooks Notifications when users, projects and keys are changed.
• Update Update guides to upgrade your installation.
• Welcome message Add a custom welcome message to the sign-in page.
• Reply by email Allow users to comment on issues and merge requests by replying to notification emails.
• Migrate GitLab CI to GitSwarm Follow this guide to migrate your existing GitLab CI data to GitSwarm.
• Git LFS configuration
• Housekeeping Keep your Git repository tidy and fast.
• GitSwarm Performance Monitoring Configure GitSwarm and InfluxDB for measuring performance metrics.
• Monitoring uptime Check the server status using the health check endpoint.
• Debugging Tips Tips to debug problems when things go wrong
• Sidekiq Troubleshooting Debug when Sidekiq appears hung and is not processing jobs.
• High Availability Configure multiple servers for scaling or high availability.
• Container Registry Configure Docker Registry with GitSwarm.
• Multiple mountpoints for the repositories storage Define multiple repository storage paths to distribute the storage load.
• Migration from GitLab CE How to migrate your existing GitLab CE workflow and repositories to GitSwarm.
• Helix Mirroring Apply bi-directional mirroring of your GitSwarm projects into the Helix Versioning Engine.

Contributor documentation

• Documentation styleguide Use this styleguide if you are contributing to documentation.
• Development Explains the architecture and the guidelines for shell commands.