Docs: Merge Various EE /doc dirs to CE
This commit is contained in:
parent
2229b18938
commit
b05936cbfa
19 changed files with 305 additions and 21 deletions
5
doc/articles/how_to_configure_ldap_gitlab_ee/index.md
Normal file
5
doc/articles/how_to_configure_ldap_gitlab_ee/index.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
redirect_to: 'https://docs.gitlab.com/ee/administration/auth/how_to_configure_ldap_gitlab_ee/index.html'
|
||||
---
|
||||
|
||||
This document was moved to [another location](https://docs.gitlab.com/ee/administration/auth/how_to_configure_ldap_gitlab_ee/index.html).
|
3
doc/getting-started/subscription.md
Normal file
3
doc/getting-started/subscription.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
redirect_to: '../subscriptions/index.md'
|
||||
---
|
5
doc/git_hooks/git_hooks.md
Normal file
5
doc/git_hooks/git_hooks.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
redirect_to: 'https://docs.gitlab.com/ee/push_rules/push_rules.html'
|
||||
---
|
||||
|
||||
This document was moved to [another location](https://docs.gitlab.com/ee/push_rules/push_rules.html)
|
|
@ -16,6 +16,7 @@ To create a project in GitLab:
|
|||
- [Import a project](../user/project/import/index.md) from a different repository,
|
||||
if enabled on your GitLab instance. Contact your GitLab admin if this
|
||||
is unavailable.
|
||||
- Run [CI/CD pipelines for external repositories](https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/index.html). **[PREMIUM]**
|
||||
|
||||
## Blank projects
|
||||
|
||||
|
@ -57,7 +58,7 @@ Built-in templates are project templates that are:
|
|||
|
||||
To use a built-in template on the **New project** page:
|
||||
|
||||
1. On the **Create from template** tab.
|
||||
1. On the **Create from template** tab, select the **Built-in** tab.
|
||||
1. From the list of available built-in templates, click the:
|
||||
- **Preview** button to look at the template source itself.
|
||||
- **Use template** button to start creating the project.
|
||||
|
|
7
doc/install/ldap.md
Normal file
7
doc/install/ldap.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
redirect_to: '../administration/auth/ldap.md'
|
||||
---
|
||||
|
||||
# GitLab LDAP integration
|
||||
|
||||
This document was moved under [`administration/auth/ldap`](../administration/auth/ldap.md).
|
45
doc/install/pivotal/index.md
Normal file
45
doc/install/pivotal/index.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
# GitLab Pivotal Tile **[PREMIUM ONLY]**
|
||||
|
||||
> Introduced in [GitLab Premium][eep] 8.2.
|
||||
|
||||
Easily deploy GitLab as a pre-configured appliance using Ops Manager (BOSH) for
|
||||
[Pivotal Cloud Foundry][pcf].
|
||||
|
||||
## Overview
|
||||
|
||||
Enterprise admins want their development toolkit to be more customizable, more
|
||||
integrated, and more secure. With Pivotal Cloud Foundry, GitLab is installed and
|
||||
scales easily in a highly available environment.
|
||||
|
||||
The upgrades are pain-free and well tested. All it takes is upload the new tile
|
||||
and click a button to begin the upgrade process.
|
||||
|
||||
## Use cases
|
||||
|
||||
- You want a highly available deployment with minimal effort. Scale horizontally
|
||||
as your user base grows.
|
||||
|
||||
## Features
|
||||
|
||||
The GitLab Pivotal Tile is based on [GitLab Premium][eep] and includes nearly all of its features. The features in Premium but _not_ supported on the Tile are:
|
||||
|
||||
* PostgreSQL
|
||||
* Pages
|
||||
* Geo
|
||||
* Registry
|
||||
* Mattermost
|
||||
* Subgroups
|
||||
* Elasticsearch
|
||||
* Service Desk
|
||||
* OAuth & Kerberos Authentication
|
||||
|
||||
## Installing GitLab with Pivotal
|
||||
|
||||
The product information and installation documentation is hosted on Pivotal's
|
||||
website:
|
||||
|
||||
- [Product page](https://network.pivotal.io/products/p-gitlab/)
|
||||
- [Documentation](https://docs.pivotal.io/partners/gitlab/index.html)
|
||||
|
||||
[eep]: https://about.gitlab.com/pricing/
|
||||
[pcf]: https://pivotal.io/platform
|
|
@ -105,8 +105,10 @@ features of GitLab work with MySQL/MariaDB:
|
|||
|
||||
1. MySQL support for subgroups was [dropped with GitLab 9.3][post].
|
||||
See [issue #30472][30472] for more information.
|
||||
1. Geo does [not support MySQL](https://docs.gitlab.com/ee/administration/geo/replication/database.html#mysql-replication). This means no supported Disaster Recovery solution if using MySQL. **[PREMIUM ONLY]**
|
||||
1. Geo does [not support MySQL](https://docs.gitlab.com/ee/administration/geo/replication/database.html). This means no supported Disaster Recovery solution if using MySQL. **[PREMIUM ONLY]**
|
||||
1. [Zero downtime migrations](../update/README.md#upgrading-without-downtime) do not work with MySQL.
|
||||
1. [Database load balancing](https://docs.gitlab.com/ee/administration/database_load_balancing.html) is
|
||||
supported only for PostgreSQL. **[PREMIUM ONLY]**
|
||||
1. GitLab [optimizes the loading of dashboard events](https://gitlab.com/gitlab-org/gitlab-ce/issues/31806) using [PostgreSQL LATERAL JOINs](https://blog.heapanalytics.com/postgresqls-powerful-new-join-type-lateral/).
|
||||
1. In general, SQL optimized for PostgreSQL may run much slower in MySQL due to
|
||||
differences in query planners. For example, subqueries that work well in PostgreSQL
|
||||
|
@ -141,7 +143,17 @@ On some systems you may need to install an additional package (e.g.
|
|||
|
||||
#### Additional requirements for GitLab Geo
|
||||
|
||||
If you are using [GitLab Geo](https://docs.gitlab.com/ee/development/geo.html), the [tracking database](https://docs.gitlab.com/ee/development/geo.html#geo-tracking-database) also requires the `postgres_fdw` extension.
|
||||
If you are using [GitLab Geo](https://docs.gitlab.com/ee/development/geo.html):
|
||||
|
||||
- We strongly recommend running Omnibus-managed instances as they are actively
|
||||
developed and tested. We aim to be compatible with most external (not managed
|
||||
by Omnibus) databases (for example, AWS RDS) but we do not guarantee
|
||||
compatibility.
|
||||
- The
|
||||
[tracking database](https://docs.gitlab.com/ee/development/geo.html#geo-tracking-database)
|
||||
requires the
|
||||
[postgres_fdw](https://www.postgresql.org/docs/9.6/static/postgres-fdw.html)
|
||||
extension.
|
||||
|
||||
```
|
||||
CREATE EXTENSION postgres_fdw;
|
||||
|
|
|
@ -1,3 +1,29 @@
|
|||
---
|
||||
redirect_to: 'README.md'
|
||||
---
|
||||
# Corporate contributor license agreement
|
||||
|
||||
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to GitLab B.V.. Except for the license granted herein to GitLab B.V. and recipients of software distributed by GitLab B.V., You reserve all right, title, and interest in and to Your Contributions.
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with GitLab B.V.. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"Contribution" shall mean the code, documentation or other original works of authorship, including any modifications or additions to an existing work, that is submitted by You to GitLab B.V. for inclusion in, or documentation of, any of the products owned or managed by GitLab B.V. (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to GitLab B.V. or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, GitLab B.V. for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
|
||||
|
||||
2. Grant of Copyright License.
|
||||
|
||||
Subject to the terms and conditions of this Agreement, You hereby grant to GitLab B.V. and to recipients of software distributed by GitLab B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
|
||||
|
||||
3. Grant of Patent License.
|
||||
|
||||
Subject to the terms and conditions of this Agreement, You hereby grant to GitLab B.V. and to recipients of software distributed by GitLab B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
4. You represent that You are legally entitled to grant the above license. You represent further that each of Your employees is authorized to submit Contributions on Your behalf, but excluding employees that are designated in writing by You as "Not authorized to submit Contributions on behalf of [name of Your corporation here]." Such designations of exclusion for unauthorized employees are to be submitted via email to legal@gitlab.com.
|
||||
|
||||
5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others).
|
||||
|
||||
6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
7. Should You wish to submit work that is not Your original creation, You may submit it to GitLab B.V. separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
|
||||
|
||||
8. It is Your responsibility to notify GitLab.com when any change is required to the list of designated employees excluded from submitting Contributions on Your behalf per Section 4. Such notification should be sent via email to legal@gitlab.com.
|
||||
|
||||
This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office.
|
||||
|
|
|
@ -1,3 +1,25 @@
|
|||
---
|
||||
redirect_to: 'README.md'
|
||||
---
|
||||
# Individual contributor license agreement
|
||||
|
||||
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to GitLab B.V.. Except for the license granted herein to GitLab B.V. and recipients of software distributed by GitLab B.V., You reserve all right, title, and interest in and to Your Contributions.
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with GitLab B.V.. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to GitLab B.V. for inclusion in, or documentation of, any of the products owned or managed by GitLab B.V. (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to GitLab B.V. or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, GitLab B.V. for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to GitLab B.V. and to recipients of software distributed by GitLab B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to GitLab B.V. and to recipients of software distributed by GitLab B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to GitLab B.V., or that your employer has executed a separate Corporate CLA with GitLab B.V..
|
||||
|
||||
5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
|
||||
|
||||
6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
7. Should You wish to submit work that is not Your original creation, You may submit it to GitLab B.V. separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [insert_name_here]".
|
||||
|
||||
8. You agree to notify GitLab B.V. of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
|
||||
|
||||
This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office.
|
||||
|
|
5
doc/license/README.md
Normal file
5
doc/license/README.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
redirect_to: 'https://docs.gitlab.com/ee/user/admin_area/license.html'
|
||||
---
|
||||
|
||||
This document was moved to [user/admin_area/license](https://docs.gitlab.com/ee/user/admin_area/license.html).
|
|
@ -23,6 +23,16 @@ sudo gitlab-rake gitlab:cleanup:repos
|
|||
bundle exec rake gitlab:cleanup:repos RAILS_ENV=production
|
||||
```
|
||||
|
||||
Remove old repository copies from repositories moved to another storage.
|
||||
|
||||
```
|
||||
# omnibus-gitlab
|
||||
sudo gitlab-rake gitlab:cleanup:moved
|
||||
|
||||
# installation from source
|
||||
bundle exec rake gitlab:cleanup:moved RAILS_ENV=production
|
||||
```
|
||||
|
||||
Clean up local project upload files if they don't exist in GitLab database. The
|
||||
task attempts to fix the file if it can find its project, otherwise it moves the
|
||||
file to a lost and found directory.
|
||||
|
|
BIN
doc/subscriptions/billing_table.png
Normal file
BIN
doc/subscriptions/billing_table.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
103
doc/subscriptions/index.md
Normal file
103
doc/subscriptions/index.md
Normal file
|
@ -0,0 +1,103 @@
|
|||
# Subscription setup and management
|
||||
|
||||
This page will help get you started with your new subscription or manage an existing one, whether you have subscribed to GitLab.com or self-managed GitLab.
|
||||
|
||||
To subscribe, upgrade, or read more about the types of subscriptions, please see [Subscribe to GitLab](../README.md#subscribe-to-gitlab) on the GitLab Documentation landing page.
|
||||
|
||||
## Set up GitLab
|
||||
|
||||
Learn how GitLab helps you in the stages of the DevOps lifecycle by learning more [about the GitLab product](https://about.gitlab.com/product/), [GitLab features](https://about.gitlab.com/features/), and [GitLab Documentation](../README.md).
|
||||
|
||||
### Self-managed: Install GitLab
|
||||
|
||||
Take a look at [installing GitLab](https://about.gitlab.com/install/) and our [administrator documentation](../administration/index.md). Then, follow the instructions below under [Your subscription](#your-subscription) to apply your license file.
|
||||
|
||||
### GitLab.com: Create a user and group
|
||||
|
||||
Start with creating a user account for yourself using our [sign up page](https://gitlab.com/users/sign_in#register-pane).
|
||||
|
||||
[GitLab groups](../user/group/index.md) help assemble related projects together allowing you to grant members access to several projects at once. A group is not required if you plan on having [projects](../user/project/) inside a personal namespace.
|
||||
|
||||
## Your subscription
|
||||
|
||||
You can view and manage subscriptions through our [Customers portal](https://customers.gitlab.com/). Information on applying your subscription is below.
|
||||
|
||||
Please also see our [subscription FAQ](https://about.gitlab.com/pricing/licensing-faq/)
|
||||
|
||||
### View subscription and seats
|
||||
|
||||
To view and manage the subscriptions you have purchased and the number of seats associated with the subscription, please visit and log into the [Customers’ Portal](https://customers.gitlab.com/subscriptions). For more information, please see our [subscription FAQ](https://about.gitlab.com/pricing/licensing-faq/) and [pricing page](https://about.gitlab.com/pricing/), which includes information on our [true-up pricing policy](https://about.gitlab.com/handbook/product/pricing/#true-up-pricing) when adding more users than at the time of purchase.
|
||||
|
||||
Please note that this account may have the same email, but is a _separate_ login from your GitLab.com account. If the two accounts are linked together, then you can use the "sign in with GitLab.com account" link underneath the `Sign In` button.
|
||||
|
||||
### Change billing information
|
||||
|
||||
In the customers portal, go to the `My Account` page, then revise the `Account Details` information and click on the `Update Account` button.
|
||||
|
||||
Future purchases will use the information in this section. The email listed in this section is used for the Customers Portal login and for license related email communication.
|
||||
|
||||
### Self-managed: Apply your license file
|
||||
|
||||
After purchase, the license file is sent to the email address tied to the Customers portal account, which needs to be [uploaded to the GitLab instance](https://docs.gitlab.com/ee/user/admin_area/license.html#uploading-your-license).
|
||||
|
||||
### Link your GitLab.com account with your Customers Portal account
|
||||
|
||||
NOTE: **Note:** This is *required* for GitLab.com subscriptions.
|
||||
|
||||
Once signed into the customers portal, if your account is not already linked, you should be prompted to link your account with a "Link my GitLab Account" button.
|
||||
|
||||
You can also go to the [My Account](https://customers.gitlab.com/customers/edit) page to add or change the GitLab.com account link.
|
||||
|
||||
### Change the linked GitLab.com account for your Customers Portal account
|
||||
|
||||
To change which GitLab.com account is associated with a Customers Portal account, please follow these steps:
|
||||
|
||||
1. Log into the [Customers Portal](https://customers.gitlab.com/customers/sign_in).
|
||||
1. In a separate browser tab, visit [GitLab.com](https://gitlab.com) to ensure you are not logged in, or if you are, log out.
|
||||
1. Back on the Customers Portal page, click [My Account](https://customers.gitlab.com/customers/edit) in the top menu.
|
||||
1. Under `Your GitLab.com account`, click the `Change linked account` button.
|
||||
1. Have the user you want associated log in to their [GitLab.com](https://gitlab.com) account.
|
||||
|
||||
### GitLab.com: Associate your namespace with your subscription
|
||||
|
||||
Once your GitLab.com account is linked, you can go to your [Subscriptions](https://customers.gitlab.com/subscriptions) page to choose or change the namespace your subscription applies to.
|
||||
|
||||
Please note that you need to be a group owner to associate a group to your subscription.
|
||||
|
||||
### Confirm or upgrade your GitLab.com subscription details within GitLab
|
||||
|
||||
To see the status of your GitLab.com subscription, you can click on the Billings
|
||||
section of the relevant namespace:
|
||||
|
||||
* For individuals, this is located at https://gitlab.com/profile/billings under
|
||||
in your Settings,
|
||||
* For groups, this is located under the group's Settings dropdown, under Billing.
|
||||
|
||||
For groups, you can see details of your subscription - including your current
|
||||
plan - in the included table:
|
||||
|
||||
![Billing table](billing_table.png)
|
||||
|
||||
| Field | Description |
|
||||
| ------ | ------ |
|
||||
| Seats in subscription | If this is a paid plan, this represents the number of seats you've paid to support in your group. |
|
||||
| Seats currently in use | The number of active seats currently in use. |
|
||||
| Max seats used | The highest number of seats you've used. If this exceeds the seats in subscription, you may owe an additional fee for the additional users. |
|
||||
| Seats owed | If your max seats used exceeds the seats in your subscription, you'll owe an additional fee for the users you've added. |
|
||||
| Subscription start date | The date your subscription started. If this is for a Free plan, this is the date you transitioned off your group's paid plan. |
|
||||
| Subscription end date | The date your current subscription will end. This does not apply to Free plans. |
|
||||
|
||||
## Need help?
|
||||
|
||||
[GitLab's Documentation](https://docs.gitlab.com/) offers a wide range of topics covering the use and administration of GitLab.
|
||||
|
||||
We also encourage all users to search our project trackers for known issues and existing feature requests in:
|
||||
|
||||
- [GitLab CE](https://gitlab.com/gitlab-org/gitlab-ce/issues/) for features included in all tiers, and
|
||||
- [GitLab EE](https://gitlab.com/gitlab-org/gitlab-ee/issues/) for paid-tier features.
|
||||
|
||||
These issues are the best avenue for getting updates on specific product plans and for communicating directly with the relevant GitLab team members.
|
||||
|
||||
### Contacting Support
|
||||
|
||||
Learn more about the tiers of [GitLab Support](https://about.gitlab.com/support/) or [submit a request via the Support Portal](https://support.gitlab.com/hc/en-us/requests/new).
|
38
doc/tools/email.md
Normal file
38
doc/tools/email.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# Email from GitLab **[STARTER ONLY]**
|
||||
|
||||
As a GitLab administrator you can email GitLab users from within GitLab.
|
||||
|
||||
## Overview
|
||||
|
||||
GitLab provides a simple tool to email all users or users of a chosen group or
|
||||
project right from the admin area. Users will receive the email to their primary
|
||||
email address.
|
||||
|
||||
## Use-cases
|
||||
|
||||
- Notify your users about a new project, a new feature, or a new product launch.
|
||||
- Notify your users about a new deployment, or that will be downtime expected
|
||||
for a particular reason.
|
||||
|
||||
## Sending emails to users from within GitLab
|
||||
|
||||
1. Go to the admin area using the wrench icon in the top right corner and
|
||||
navigate to **Overview > Users > Send email to users**.
|
||||
|
||||
![admin users](email1.png)
|
||||
|
||||
1. Compose an email and choose where it will be sent (all users or users of a
|
||||
chosen group or project):
|
||||
|
||||
![compose an email](email2.png)
|
||||
|
||||
## Unsubscribing from emails
|
||||
|
||||
User can choose to unsubscribe from receiving emails from GitLab by following
|
||||
the unsubscribe link from the email. Unsubscribing is unauthenticated in order
|
||||
to keep the simplicity of this feature.
|
||||
|
||||
On unsubscribe, user will receive an email notifying that unsubscribe happened.
|
||||
The endpoint that provides the unsubscribe option is rate-limited.
|
||||
|
||||
[ee]: https://about.gitlab.com/pricing/
|
BIN
doc/tools/email1.png
Normal file
BIN
doc/tools/email1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.4 KiB |
BIN
doc/tools/email2.png
Normal file
BIN
doc/tools/email2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
|
@ -30,6 +30,8 @@ This page gathers all the resources for the topic **Authentication** within GitL
|
|||
- [Atlassian Crowd OmniAuth Provider](../../administration/auth/crowd.md)
|
||||
- [CAS OmniAuth Provider](../../integration/cas.md)
|
||||
- [SAML OmniAuth Provider](../../integration/saml.md)
|
||||
- [SAML for GitLab.com Groups](https://docs.gitlab.com/ee/user/group/saml_sso/index.html)
|
||||
- [SCIM user provisioning for GitLab.com Groups](https://docs.gitlab.com/ee/user/group/saml_sso/scim_setup.html)
|
||||
- [Okta SSO provider](../../administration/auth/okta.md)
|
||||
- [Kerberos integration (GitLab EE)](https://docs.gitlab.com/ee/integration/kerberos.html)
|
||||
|
||||
|
|
|
@ -179,7 +179,7 @@ Those environments are tied to jobs that use [Auto Deploy](#auto-deploy), so
|
|||
except for the environment scope, they would also need to have a different
|
||||
domain they would be deployed to. This is why you need to define a separate
|
||||
`KUBE_INGRESS_BASE_DOMAIN` variable for all the above
|
||||
[based on the environment](https://docs.gitlab.com/ee/ci/variables/index.html#limiting-environment-scopes-of-variables-premium).
|
||||
[based on the environment](https://docs.gitlab.com/ee/ci/variables/#limiting-environment-scopes-of-environment-variables-premium).
|
||||
|
||||
The following table is an example of how the three different clusters would
|
||||
be configured.
|
||||
|
@ -377,8 +377,8 @@ analysis on the current code and checks for potential security issues. Once the
|
|||
report is created, it's uploaded as an artifact which you can later download and
|
||||
check out.
|
||||
|
||||
Any security warnings are also
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/sast.html).
|
||||
Any security warnings are also shown in the merge request widget. Read more how
|
||||
[SAST works](https://docs.gitlab.com/ee/user/application_security/sast/index.html).
|
||||
|
||||
NOTE: **Note:**
|
||||
The Auto SAST stage will be skipped on licenses other than Ultimate.
|
||||
|
@ -396,8 +396,8 @@ to run analysis on the project dependencies and checks for potential security is
|
|||
report is created, it's uploaded as an artifact which you can later download and
|
||||
check out.
|
||||
|
||||
Any security warnings are also
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/dependency_scanning.html).
|
||||
Any security warnings are also shown in the merge request widget. Read more about
|
||||
[Dependency Scanning](https://docs.gitlab.com/ee/user/application_security/dependency_scanning/index.html).
|
||||
|
||||
NOTE: **Note:**
|
||||
The Auto Dependency Scanning stage will be skipped on licenses other than Ultimate.
|
||||
|
@ -415,8 +415,8 @@ to search the project dependencies for their license. Once the
|
|||
report is created, it's uploaded as an artifact which you can later download and
|
||||
check out.
|
||||
|
||||
Any licenses are also
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/license_management.html).
|
||||
Any licenses are also shown in the merge request widget. Read more how
|
||||
[License Management works](https://docs.gitlab.com/ee/user/application_security/license_management/index.html).
|
||||
|
||||
NOTE: **Note:**
|
||||
The Auto License Management stage will be skipped on licenses other than Ultimate.
|
||||
|
@ -431,8 +431,8 @@ Docker image and checks for potential security issues. Once the report is
|
|||
created, it's uploaded as an artifact which you can later download and
|
||||
check out.
|
||||
|
||||
Any security warnings are also
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/container_scanning.html).
|
||||
Any security warnings are also shown in the merge request widget. Read more how
|
||||
[Container Scanning works](https://docs.gitlab.com/ee/user/application_security/container_scanning/index.html).
|
||||
|
||||
NOTE: **Note:**
|
||||
The Auto Container Scanning stage will be skipped on licenses other than Ultimate.
|
||||
|
@ -487,8 +487,8 @@ to perform an analysis on the current code and checks for potential security
|
|||
issues. Once the report is created, it's uploaded as an artifact which you can
|
||||
later download and check out.
|
||||
|
||||
Any security warnings are also
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/dast.html).
|
||||
Any security warnings are also shown in the merge request widget. Read how
|
||||
[DAST works](https://docs.gitlab.com/ee/user/application_security/dast/index.html).
|
||||
|
||||
NOTE: **Note:**
|
||||
The Auto DAST stage will be skipped on licenses other than Ultimate.
|
||||
|
|
|
@ -35,7 +35,7 @@ fi
|
|||
|
||||
# Do not use 'README.md', instead use 'index.md'
|
||||
# Number of 'README.md's as of 2018-03-26
|
||||
NUMBER_READMES_CE=44
|
||||
NUMBER_READMES_CE=45
|
||||
NUMBER_READMES_EE=46
|
||||
FIND_READMES=$(find doc/ -name "README.md" | wc -l)
|
||||
echo '=> Checking for new README.md files...'
|
||||
|
|
Loading…
Reference in a new issue