GitSwarm-EE 2017.1-1 Documentation

---

Documentation

User documentation

• API Automate GitSwarm EE via a simple and powerful API.
• CI/CD GitLab Continuous Integration (CI) and Continuous Delivery (CD) getting started, .gitlab-ci.yml options, and examples.
• GitSwarm EE as OAuth2 authentication service provider. It allows you to login to other applications from GitSwarm EE.
• Container Registry Learn how to use GitLab Container Registry.
• GitSwarm EE Basics Find step-by-step how to start working on your commandline and on GitSwarm EE.
• Importing to GitSwarm EE.
• Importing and exporting projects between instances.
• Markdown GitSwarm EE's advanced formatting system.
• Migrating from SVN Convert an SVN repository to Git and GitSwarm EE.
• 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.
• Analytics
• SSH Setup your ssh keys and deploy keys for secure access to your projects.
• Webhooks Let GitSwarm EE notify you when new code has been pushed to your project.
• Workflow Using GitSwarm EE functionality and importing projects from GitHub and SVN.
• GitSwarm EE Pages Using GitSwarm EE Pages.
• Custom templates for issues and merge requests Pre-fill the description of issues and merge requests to your liking.

Administrator documentation

• Migration from GitLab How to migrate your existing GitLab workflow and repositories to GitSwarm.
• Helix Mirroring Apply bi-directtional mirroring of your GitSwarm EE projects into the Helix Versioning Engine.
• Audit Events Check how user access changed in projects and groups.
• Access restrictions Define which Git access protocols can be used to talk to GitLab
• Authentication/Authorization Configure external authentication with LDAP, SAML, CAS and additional Omniauth providers.
• Changing the appearance of the login page Make the login page branded for your GitSwarm EE instance.
• Custom git hooks Custom git hooks (on the filesystem) for when webhooks aren't enough.
• Email Email GitSwarm EE users from GitSwarm EE.
• Push Rules Advanced push rules for your project.
• Help message Set information about administrators of your GitSwarm EE instance.
• Install Requirements, directory structures and installation from source.
• Installing your license
• Integration How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
• Restart GitSwarm EE Learn how to restart GitSwarm EE and its components.
• Issue closing Customize how to close an issue from commit messages.
• Libravatar Use Libravatar for user avatars.
• Log system Log system.
• Environment Variables to configure GitSwarm EE.
• Operations Keeping GitSwarm EE 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 EE 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 CE/EE Follow this guide to migrate your existing GitLab CI data to GitSwarm CE/EE.
• Downgrade back to GitSwarm Follow this guide if you need to downgrade from GitSwarm EE to GitSwarm.
• git-annex configuration
• Git LFS configuration
• Housekeeping Keep your Git repository tidy and fast.
• GitSwarm EE Pages configuration Configure GitSwarm EE Pages.
• Elasticsearch Enable Elasticsearch.
• GitSwarm EE GEO Configure GitSwarm EE GEO, a secondary read-only GitSwarm EE instance.
• GitSwarm EE Performance Monitoring Configure GitSwarm EE 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 EE.
• Multiple mountpoints for the repositories storage Define multiple repository storage paths to distribute the storage load.

Contributor documentation

• Documentation styleguide Use this styleguide if you are contributing to documentation.
• Development Details on contributing back changes.
• Legal Contributor license agreements.