1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gitlab_ynh.git synced 2024-09-03 18:36:35 +02:00
gitlab_ynh/README.md

66 lines
2.4 KiB
Markdown
Raw Normal View History

2021-05-28 17:18:32 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2020-06-08 17:46:46 +02:00
# GitLab for YunoHost
2017-06-10 10:10:31 +02:00
2021-05-28 17:18:32 +02:00
[![Integration level](https://dash.yunohost.org/integration/gitlab.svg)](https://dash.yunohost.org/appci/app/gitlab) ![](https://ci-apps.yunohost.org/ci/badges/gitlab.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gitlab.maintain.svg)
2020-12-23 16:58:58 +01:00
[![Install GitLab with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitlab)
2017-06-10 10:10:31 +02:00
2020-06-08 17:46:46 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-05-28 17:18:32 +02:00
> *This package allows you to install GitLab quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2017-06-10 10:10:31 +02:00
2018-12-17 12:45:00 +01:00
## Overview
2017-06-10 10:10:31 +02:00
2021-05-28 17:18:32 +02:00
Git-repository manager providing wiki, issue-tracking and CI/CD pipeline features.
2018-12-17 12:45:00 +01:00
2021-09-06 13:42:36 +02:00
**Shipped version:** 14.2.3~ynh1
2018-12-17 12:45:00 +01:00
2021-05-28 17:18:32 +02:00
**Demo:** https://gitlab.com/explore
2018-12-17 12:45:00 +01:00
2021-05-28 17:18:32 +02:00
## Screenshots
2018-12-17 12:45:00 +01:00
2021-05-28 17:18:32 +02:00
![](./doc/screenshots/GitLab_running_11.0_(2018-07).png)
2018-12-17 12:45:00 +01:00
2021-05-30 17:17:35 +02:00
## Disclaimers / important information
2021-05-30 17:19:06 +02:00
### Configuration
2021-05-30 17:17:35 +02:00
How to configure GitLab:
- With the GitLab admin panel.
- By editing the configuration file `/etc/gitlab/gitlab-persistent.rb` (use `sudo gitlab-ctl reconfigure` after any modification of this file).
2021-05-30 17:19:06 +02:00
### Multi-users support
2021-05-30 17:17:35 +02:00
* Are LDAP and HTTP auth supported? **Yes**
* Can the app be used by multiple users? **Yes**
2021-05-30 17:19:06 +02:00
### Limitations
2021-05-30 17:17:35 +02:00
* GitLab is not compatible with 32-bit architectures.
2021-05-30 20:25:22 +02:00
2021-05-28 17:18:32 +02:00
## Documentation and resources
2018-12-17 12:45:00 +01:00
2021-05-28 17:18:32 +02:00
* Official app website: https://gitlab.com
* Official user documentation: https://yunohost.org/fr/app_gitlab
* Official admin documentation: https://docs.gitlab.com/
2021-05-30 16:47:11 +02:00
* Upstream app code repository: https://gitlab.com/gitlab-org/omnibus-gitlab - https://gitlab.com/gitlab-org/gitlab
2021-05-28 17:18:32 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_gitlab
* Report a bug: https://github.com/YunoHost-Apps/gitlab_ynh/issues
2018-12-17 12:45:00 +01:00
2021-05-28 17:18:32 +02:00
## Developer info
2018-12-17 12:45:00 +01:00
2021-05-28 17:18:32 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gitlab_ynh/tree/testing).
2018-12-17 12:45:00 +01:00
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/gitlab_ynh/tree/testing --debug
or
sudo yunohost app upgrade gitlab -u https://github.com/YunoHost-Apps/gitlab_ynh/tree/testing --debug
```
2021-05-28 17:18:32 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps