gitlab-org--gitlab-foss/doc/administration/index.md
Robert Marshall 92663f7323 Document EE License Auto Import During Install
- Document how to properly configure `GITLAB_LICENSE_FILE` environment
  variable in source and omnibus installations.

Resolves: https://gitlab.com/gitlab-org/gitlab-ee/issues/10808

Signed-off-by: Robert Marshall <rmarshall@gitlab.com>
2019-05-07 18:53:25 +00:00

16 KiB
Raw Blame History

description
Learn how to install, configure, update, and maintain your GitLab instance.

Administrator documentation [CORE ONLY]

Learn how to administer your self-managed GitLab instance.

GitLab has two product distributions available through different subscriptions:

You can install either GitLab CE or GitLab EE. However, the features you'll have access to depend on the subscription you choose (Core, Starter, Premium, or Ultimate).

NOTE: Note: GitLab Community Edition installations only have access to Core features.

GitLab.com is administered by GitLab, Inc., therefore, only GitLab team members have access to its admin configurations. If you're a GitLab.com user, please check the user documentation.

NOTE: Note: Non-administrator users dont have access to GitLab administration tools and settings.

Installing and maintaining GitLab

Learn how to install, configure, update, and maintain your GitLab instance.

Installing GitLab

  • Install: Requirements, directory structures, and installation methods.
  • High Availability: Configure multiple servers for scaling or high availability.
  • Geo: Replicate your GitLab instance to other geographic locations as a read-only fully operational version. [PREMIUM ONLY]
  • Disaster Recovery: Quickly fail-over to a different site with minimal effort in a disaster situation. [PREMIUM ONLY]
  • Pivotal Tile: Deploy GitLab as a pre-configured appliance using Ops Manager (BOSH) for Pivotal Cloud Foundry. [PREMIUM ONLY]
  • Add License: Upload a license at install time to unlock features that are in paid tiers of GitLab. [STARTER ONLY]

Configuring GitLab

Customizing GitLab's appearance

  • Header logo: Change the logo on all pages and email headers.
  • Favicon: Change the default favicon to your own logo.
  • Branded login page: Customize the login page with your own logo, title, and description.
  • Welcome message: Add a custom welcome message to the sign-in page.
  • "New Project" page: Customize the text to be displayed on the page that opens whenever your users create a new project.
  • Additional custom email text: Add additional custom text to emails sent from GitLab. [PREMIUM ONLY]

Maintaining GitLab

  • Raketasks: Perform various tasks for maintenance, backups, automatic webhooks setup, etc.
  • Operations: Keeping GitLab up and running (clean up Redis sessions, moving repositories, Sidekiq MemoryKiller, Unicorn).
  • Restart GitLab: Learn how to restart GitLab and its components.
  • Invalidate markdown cache: Invalidate any cached markdown.

Updating GitLab

Upgrading or downgrading GitLab

GitLab platform integrations

  • Mattermost: Integrate with Mattermost, an open source, private cloud workplace for web messaging.
  • PlantUML: Create simple diagrams in AsciiDoc and Markdown documents created in snippets, wikis, and repos.
  • Web terminals: Provide terminal access to your applications deployed to Kubernetes from within GitLab's CI/CD environments.

User settings and permissions

Project settings

Repository settings

Continuous Integration settings

Git configuration options

Monitoring GitLab

Performance Monitoring

Analytics

  • Pseudonymizer: Export data from GitLab's database to CSV files in a secure way. [ULTIMATE]

Troubleshooting