From 80bdff8cc65c82ee718fcf88d214d4d7fd2e3bd1 Mon Sep 17 00:00:00 2001 From: Katrin Leinweber <9948149+katrinleinweber@users.noreply.github.com> Date: Fri, 26 Jul 2024 17:09:36 +0200 Subject: [PATCH] Fix typos --- CONTRIBUTING.md | 4 +- Changelog.md | 10 ++--- README.md | 70 +++++++++++++++++------------------ docs/container_registry.md | 6 +-- docs/keycloak-idp.md | 4 +- docs/s3_compatible_storage.md | 4 +- 6 files changed, 49 insertions(+), 49 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbb5cdb4..1ec79067 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # GitLab-CI Configuration -When using your own gitlab instance, the provided .gitlab-ci.yml will be automatically be using the settings provided by the GitLab Instance. If needed several options can be overriden. +When using your own GitLab instance, the provided .gitlab-ci.yml will automatically be using the settings provided by the GitLab instance. If needed, several options can be overriden. Overrides for these values can be set within the project, under `Settings` -> `CI/CD` -> `Variables`. @@ -9,4 +9,4 @@ Overrides for these values can be set within the project, under `Settings` -> `C | `CI_REGISTRY` | `hub.docker.com` | If available this will be automatically overriden by registry address which is configured within the GitLab instance | | `CI_REGISTRY_USER` | `gitlab-ci-token` | Username for the registry | | `CI_REGISTRY_PASSWORD` | `${CI_JOB_TOKEN}` | Password for the registry | -| `DOCKER_IMAGE` | `sameersbn/gitlab` | Docker image name, will be automatically be overriden by the running GitLab instance with the `${CI_PROJECT_PATH}` variable. This will case the image to be uploaded to the local registry of the project within GitLab. | +| `DOCKER_IMAGE` | `sameersbn/gitlab` | Docker image name, will automatically be overriden by the running GitLab instance with the `${CI_PROJECT_PATH}` variable. This will cause the image to be uploaded to the local registry of the project within GitLab. | diff --git a/Changelog.md b/Changelog.md index a0420ead..a8f79695 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1747,7 +1747,7 @@ This file only reflects the changes that are made in this image. Please refer to - gitlab: upgrade CE to v10.4.3 **10.4.2-1** -- FIXED SSH Host Key generation through droping the support for rsa1 +- FIXED SSH Host Key generation through dropping the support for rsa1 **10.4.2** - gitlab: upgrade CE to v10.4.2 @@ -1881,7 +1881,7 @@ This file only reflects the changes that are made in this image. Please refer to **9.4.0** - gitlab: upgrade to CE v9.4.0 - Added support for nginx_real_ip module ([#1137](https://github.com/sameersbn/docker-gitlab/pull/1137)) -- Added more security for regenarting certs ([#1288](https://github.com/sameersbn/docker-gitlab/pull/1288)) +- Added more security for regenerating certs ([#1288](https://github.com/sameersbn/docker-gitlab/pull/1288)) **9.3.9** - gitlab: upgrade to CE v9.3.9 @@ -1939,7 +1939,7 @@ This file only reflects the changes that are made in this image. Please refer to - gitlab: upgrade to CE v9.2.1 **9.2.0** -- gilab: upgrade to CE v9.2.0 +- gitlab: upgrade to CE v9.2.0 - Add flexibility to use versions committed into gitlab-ce **9.1.4** @@ -2012,7 +2012,7 @@ This file only reflects the changes that are made in this image. Please refer to - added `GITLAB_PAGES_EXTERNAL_HTTPS` - added `SSL_PAGES_KEY_PATH` - added `SSL_PAGES_CERT_PATH` -- added nodejs 7.x as core dependencie +- added nodejs 7.x as core dependencies - added gitlab-pages daemon **8.16.6** @@ -2699,7 +2699,7 @@ When you start to upgrade from `8.10-7` or below use the key of `/home/git/data/ **7.2.0-1** - fix nginx static route handling when GITLAB_RELATIVE_URL_ROOT is used. - fix relative root access without the trailing '/' character -- added seperate server block for http config in gitlab.https.permissive. Fixes #127 +- added separate server block for http config in gitlab.https.permissive. Fixes #127 - added OAUTH_GOOGLE_RESTRICT_DOMAIN config option. **7.2.0** diff --git a/README.md b/README.md index e95ad7a1..2e69608d 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Dockerfile to build a [GitLab](https://about.gitlab.com/) image for the [Docker](https://www.docker.com/products/docker-engine) opensource container platform. -GitLab CE is set up in the Docker image using the [install from source](https://docs.gitlab.com/ce/install/installation.html) method as documented in the the official GitLab documentation. +GitLab CE is set up in the Docker image using the [install from source](https://docs.gitlab.com/ce/install/installation.html) method as documented in the official GitLab documentation. For other methods to install GitLab please refer to the [Official GitLab Installation Guide](https://about.gitlab.com/install/) which includes a [GitLab image for Docker](https://docs.gitlab.com/omnibus/docker/). @@ -107,9 +107,9 @@ wget -qO- https://get.docker.com/ | sh Fedora and RHEL/CentOS users should try disabling selinux with `setenforce 0` and check if resolves the issue. If it does than there is not much that I can help you with. You can either stick with selinux disabled (not recommended by redhat) or switch to using ubuntu. -You may also set `DEBUG=true` to enable debugging of the entrypoint script, which could help you pin point any configuration issues. +You may also set `DEBUG=true` to enable debugging of the entrypoint script, which could help you pinpoint any configuration issues. -If using the latest docker version and/or disabling selinux does not fix the issue then please file a issue request on the [issues](https://github.com/sameersbn/docker-gitlab/issues) page. +If using the latest docker version and/or disabling selinux does not fix the issue then please file an issue request on the [issues](https://github.com/sameersbn/docker-gitlab/issues) page. In your issue report please make sure you provide the following information: @@ -246,7 +246,7 @@ GitLab uses a database backend to store its data. You can configure this image t **Important note:** This image is shipped with different versions of the `postgresql-client`. -During the startup of the container, the major version of the database system is checked based on the specified connection destination. Only the version of the `postgresql-client`, that matches the major version of the Postgres database is used. If the major version of any version of the included clients does not match, the latest client is used (but may causes issues). All other versions of the `postgresql-client` are deleted at runtime. +During the startup of the container, the major version of the database system is checked based on the specified connection destination. Only the version of the `postgresql-client`, that matches the major version of the Postgres database is used. If the major version of any version of the included clients does not match, the latest client is used (but may cause issues). All other versions of the `postgresql-client` are deleted at runtime. This behavior can be checked using the command `docker logs` and an output like the following should be available: @@ -261,7 +261,7 @@ Configuring gitlab::database … ```` -Please note furthermore, that only compatible versions of the `postgresql-client` to GitLab are shipped with this image. Currently these belong to +Please note furthermore, that only compatible versions of the `postgresql-client` to GitLab are shipped with this image. Currently, these belong to - `postgresql-client-13`, - `postgresql-client-14`, @@ -279,7 +279,7 @@ CREATE DATABASE gitlabhq_production; GRANT ALL PRIVILEGES ON DATABASE gitlabhq_production to gitlab; ``` -Additionally since GitLab `8.6.0` the `pg_trgm` extension should also be loaded for the `gitlabhq_production` database. +Additionally, since GitLab `8.6.0` the `pg_trgm` extension should also be loaded for the `gitlabhq_production` database. We are now ready to start the GitLab application. @@ -302,7 +302,7 @@ If a postgresql container is linked, only the `DB_HOST` and `DB_PORT` settings a To illustrate linking with a postgresql container, we will use the [sameersbn/postgresql](https://github.com/sameersbn/docker-postgresql) image. When using postgresql image in production you should mount a volume for the postgresql data store. Please refer the [README](https://github.com/sameersbn/docker-postgresql/blob/master/README.md) of docker-postgresql for details. -First, lets pull the postgresql image from the docker index. +First, let's pull the postgresql image from the docker index. ```bash docker pull sameersbn/postgresql:14-20230628 @@ -383,7 +383,7 @@ You can link this image with a redis container to satisfy gitlab's redis require To illustrate linking with a redis container, we will use the [redis](https://github.com/docker-library/redis) image. Please refer the [README](https://github.com/docker-library/docs/blob/master/redis/README.md) for details. -First, lets pull the redis image from the docker index. +First, let's pull the redis image from the docker index. ```bash docker pull redis:6.2 @@ -441,7 +441,7 @@ Please refer the [Available Configuration Parameters](#available-configuration-p #### SSL -Access to the gitlab application can be secured using SSL so as to prevent unauthorized access to the data in your repositories. While a CA certified SSL certificate allows for verification of trust via the CA, a self signed certificate can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. I will provide instructions on achieving this towards the end of this section. +Access to the gitlab application can be secured using SSL so as to prevent unauthorized access to the data in your repositories. While a CA certified SSL certificate allows for verification of trust via the CA, a self-signed certificate can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. I will provide instructions on achieving this towards the end of this section. Jump to the [Using HTTPS with a load balancer](#using-https-with-a-load-balancer) section if you are using a load balancer such as hipache, haproxy or nginx. @@ -496,7 +496,7 @@ In case use of docker-compose ... ```$>docker volume inspect``` -look for "< user >_gitlab-data" and copy the "certs" directory into the "Mountpoint" +Look for "< user >_gitlab-data" and copy the "certs" directory into the "Mountpoint" ```bash mkdir -p /srv/docker/gitlab/gitlab/certs @@ -506,7 +506,7 @@ cp dhparam.pem /srv/docker/gitlab/gitlab/certs/ chmod 400 /srv/docker/gitlab/gitlab/certs/gitlab.key ``` -Great! we are now just one step away from having our application secured. +Great! We are now just one step away from having our application secured. ##### Enabling HTTPS support @@ -527,7 +527,7 @@ In this configuration, any requests made over the plain http protocol will autom HSTS if supported by the browsers makes sure that your users will only reach your sever via HTTPS. When the user comes for the first time it sees a header from the server which states for how long from now this site should only be reachable via HTTPS - that's the HSTS max-age value. -With `NGINX_HSTS_MAXAGE` you can configure that value. The default value is `31536000` seconds. If you want to disable a already sent HSTS MAXAGE value, set it to `0`. +With `NGINX_HSTS_MAXAGE` you can configure that value. The default value is `31536000` seconds. If you want to disable an already sent HSTS MAXAGE value, set it to `0`. ```bash docker run --name gitlab -d \ @@ -543,7 +543,7 @@ If you want to completely disable HSTS set `NGINX_HSTS_ENABLED` to `false`. Load balancers like nginx/haproxy/hipache talk to backend applications over plain http and as such the installation of ssl keys and certificates are not required and should **NOT** be installed in the container. The SSL configuration has to instead be done at the load balancer. -However, when using a load balancer you **MUST** set `GITLAB_HTTPS` to `true`. Additionally you will need to set the `SSL_SELF_SIGNED` option to `true` if self signed SSL certificates are in use. +However, when using a load balancer you **MUST** set `GITLAB_HTTPS` to `true`. Additionally, you will need to set the `SSL_SELF_SIGNED` option to `true` if self-signed SSL certificates are in use. With this in place, you should configure the load balancer to support handling of https requests. But that is out of the scope of this document. Please refer to [Using SSL/HTTPS with HAProxy](http://seanmcgary.com/posts/using-sslhttps-with-haproxy) for information on the subject. @@ -568,7 +568,7 @@ In case GitLab responds to any kind of POST request (login, OAUTH, changing sett ##### Establishing trust with your server -This section deals will self-signed ssl certificates. If you are using CA certified certificates, your done. +This section deals will self-signed ssl certificates. If you are using CA certified certificates, you're done. This section is more of a client side configuration so as to add a level of confidence at the client to be 100 percent sure they are communicating with whom they think they. @@ -597,7 +597,7 @@ By default, our own server certificate [gitlab.crt](#generation-of-self-signed-c #### Deploy to a subdirectory (relative url root) -By default GitLab expects that your application is running at the root (eg. /). This section explains how to run your application inside a directory. +By default, GitLab expects that your application is running at the root e.g.. /). This section explains how to run your application inside a directory. Let's assume we want to deploy our application to '/git'. GitLab needs to know this directory to generate the appropriate routes. This can be specified using the `GITLAB_RELATIVE_URL_ROOT` configuration option like so: @@ -646,7 +646,7 @@ You can also restrict logins to a single domain by adding `--env "OAUTH_GOOGLE_R ##### Facebook -To enable the Facebook OAuth2 OmniAuth provider you must register your application with Facebook. Facebook will generate a API key and secret for you to use. Please refer to the GitLab [documentation](http://doc.gitlab.com/ce/integration/facebook.html) for the procedure to generate the API key and secret. +To enable the Facebook OAuth2 OmniAuth provider you must register your application with Facebook. Facebook will generate an API key and secret for you to use. Please refer to the GitLab [documentation](http://doc.gitlab.com/ce/integration/facebook.html) for the procedure to generate the API key and secret. Once you have the API key and secret generated, configure them using the `OAUTH_FACEBOOK_API_KEY` and `OAUTH_FACEBOOK_APP_SECRET` environment variables respectively. @@ -654,7 +654,7 @@ For example, if your API key is `xxx` and the API secret key is `yyy`, then addi ##### Twitter -To enable the Twitter OAuth2 OmniAuth provider you must register your application with Twitter. Twitter will generate a API key and secret for you to use. Please refer to the GitLab [documentation](http://doc.gitlab.com/ce/integration/twitter.html) for the procedure to generate the API key and secret with twitter. +To enable the Twitter OAuth2 OmniAuth provider you must register your application with Twitter. Twitter will generate an API key and secret for you to use. Please refer to the GitLab [documentation](http://doc.gitlab.com/ce/integration/twitter.html) for the procedure to generate the API key and secret with twitter. Once you have the API key and secret generated, configure them using the `OAUTH_TWITTER_API_KEY` and `OAUTH_TWITTER_APP_SECRET` environment variables respectively. @@ -752,7 +752,7 @@ See [GitLab OIDC documentation](https://docs.gitlab.com/ee/administration/auth/o #### Gitlab Pages -Gitlab Pages allows a user to host static websites from a project. Gitlab pages can be enabled with setting the envrionment variable `GITLAB_PAGES_ENABLED` to `true`. +Gitlab Pages allows a user to host static websites from a project. Gitlab pages can be enabled with setting the environment variable `GITLAB_PAGES_ENABLED` to `true`. #### Gitlab Pages Access Control @@ -760,7 +760,7 @@ Since version `11.5.0` Gitlab pages supports access control. This allows only ac Gitlab pages access control requires additional configuration before activating it through the variable `GITLAB_PAGES_ACCESS_CONTROL`. -Gitab pages access control makes use of the Gitlab OAuth Module. +GitLab pages access control makes use of the Gitlab OAuth Module. - Goto the Gitlab Admin area - Select `Applications` in the menu @@ -771,11 +771,11 @@ Gitab pages access control makes use of the Gitlab OAuth Module. - Trusted: NO (Do not select) - Redirect URI: `https://projects./auth` -Note about the `Redirect URI`; this can be tricky to configure or figure out, What needs to be achieved is to following, the redirect URI needs to end up at the `gitlab-pages` daemon with the `/auth` endpoint. +Note about the `Redirect URI`; this can be tricky to configure or figure out, What needs to be achieved is the following, the redirect URI needs to end up at the `gitlab-pages` daemon with the `/auth` endpoint. -This means that if you run your gitlab pages at domain `pages.example.io` this will be a wilcard domain where your projects are created based on their namespace. The best trick is to enter a NON-Existing gitlab project pages URI as the redirect URI. +This means that if you run your gitlab pages at domain `pages.example.io` this will be a wildcard domain where your projects are created based on their namespace. The best trick is to enter a NON-Existing gitlab project pages URI as the redirect URI. -In the example above; the pages domain `projects` has been chosen. This will cause the nginx, either the built in or your own loadbalancer to redirect `*.` to the `gitlab-pages` daemon. Which will trigger the pages endpoint. +In the example above; the pages domain `projects` has been chosen. This will cause the nginx, either the built in or your own load balancer to redirect `*.` to the `gitlab-pages` daemon. Which will trigger the pages endpoint. Make sure to choose own which does not exist and make sure that the request is routed to the `gitlab-pages` daemon if you are using your own HTTP load balancer in front of Gitlab. @@ -789,10 +789,10 @@ Add to following environment variables to your Gitlab Container. | GITLAB_PAGES_ACCESS_SECRET | Optional | Secret Hash, minimal 32 characters, if omitted, it will be auto generated. | | GITLAB_PAGES_ACCESS_CONTROL_SERVER | Required | Gitlab instance URI, example: `https://gitlab.example.io` | | GITLAB_PAGES_ACCESS_CLIENT_ID | Required | Client ID from earlier generated OAuth application | -| GITLAB_PAGES_ACCESS_CLIENT_SECRET | Required | Client Secret from earlier genereated OAuth application | +| GITLAB_PAGES_ACCESS_CLIENT_SECRET | Required | Client Secret from earlier generated OAuth application | | GITLAB_PAGES_ACCESS_REDIRECT_URI | Required | Redirect URI, non existing pages domain to redirect to pages daemon, `https://projects.example.io` | -After you have enabled the gitlab pages access control. When you go to a project `General Settings` -> `Permissions` you can choose the pages persmission level for the project. +After you have enabled the gitlab pages access control. When you go to a project `General Settings` -> `Permissions` you can choose the pages permission level for the project. #### External Issue Trackers @@ -919,7 +919,7 @@ Encryption key for session secrets. Ensure that your key is at least 64 characte ##### `GITLAB_TIMEZONE` -Configure the timezone for the gitlab application. This configuration does not effect cron jobs. Defaults to `UTC`. See the list of [acceptable values](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html). For settings the container timezone which will effect cron, see variable `TZ` +Configure the timezone for the gitlab application. This configuration does not effect cron jobs. Defaults to `UTC`. See the list of [acceptable values](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html). For settings the container timezone which will affect cron, see variable `TZ` ##### `GITLAB_ROOT_PASSWORD` @@ -1255,7 +1255,7 @@ Default Google key file. Defaults to `$GITLAB_OBJECT_STORE_CONNECTION_GOOGLE_JSO ##### `GITLAB_PACKAGES_ENABLED` -Enable/Disable Pakages support. Defaults to `true`. +Enable/Disable Packages support. Defaults to `true`. ##### `GITLAB_PACKAGES_DIR` @@ -1551,7 +1551,7 @@ Sets GitLab Pages to HTTPS and the gitlab-pages-ssl config will be used. Default ##### `GITLAB_PAGES_ARTIFACTS_SERVER` -Set to `true` to enable pages artifactsserver, enabled by default. +Set to `true` to enable pages artifacts server, enabled by default. ##### `GITLAB_PAGES_ARTIFACTS_SERVER_URL` @@ -1559,11 +1559,11 @@ If `GITLAB_PAGES_ARTIFACTS_SERVER` is enabled, set to API endpoint for GitLab Pa ##### `GITLAB_PAGES_EXTERNAL_HTTP` -Sets GitLab Pages external http to receive request on an independen port. Disabled by default +Sets GitLab Pages external http to receive request on an independent port. Disabled by default ##### `GITLAB_PAGES_EXTERNAL_HTTPS` -Sets GitLab Pages external https to receive request on an independen port. Disabled by default +Sets GitLab Pages external https to receive request on an independent port. Disabled by default ##### `GITLAB_PAGES_ACCESS_CONTROL` @@ -1587,7 +1587,7 @@ Client ID from earlier generated OAuth application ##### `GITLAB_PAGES_ACCESS_CLIENT_SECRET` -Client Secret from earlier genereated OAuth application +Client Secret from earlier generated OAuth application ##### `GITLAB_PAGES_ACCESS_REDIRECT_URI` @@ -1710,7 +1710,7 @@ This parameter is the same as [`GITLAB_FEATURE_FLAGS_DISABLE_TARGETS`](#gitlab_f ##### `SSL_SELF_SIGNED` -Set to `true` when using self signed ssl certificates. `false` by default. +Set to `true` when using self-signed ssl certificates. `false` by default. ##### `SSL_CERTIFICATE_PATH` @@ -1898,7 +1898,7 @@ The database database connection pool count. Defaults to `10`. ##### `DB_PREPARED_STATEMENTS` -Whether use database prepared statements. No defaults. But set to `false` if you want to use with [PgBouncer](https://pgbouncer.github.io/) +Whether to use database prepared statements. No defaults. But set to `false` if you want to use with [PgBouncer](https://pgbouncer.github.io/) ##### `SMTP_ENABLED` @@ -2062,7 +2062,7 @@ Attribute fields for the shown mail address. Default to `['mail', 'email', 'user ##### `LDAP_USER_ATTRIBUTE_NAME` -Attribute field for the used username of a user. Default to `cn`. +Attribute field for the used username of a user. Defaults to `cn`. ##### `LDAP_USER_ATTRIBUTE_FIRSTNAME` @@ -2442,7 +2442,7 @@ AWS bucket for backup uploads. No defaults. ##### `AWS_BACKUP_MULTIPART_CHUNK_SIZE` -Enables mulitpart uploads when file size reaches a defined size. See at [AWS S3 Docs](http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) +Enables multipart uploads when file size reaches a defined size. See at [AWS S3 Docs](http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) ##### `AWS_BACKUP_ENCRYPTION` @@ -2642,7 +2642,7 @@ The image can be configured to automatically upload the backups to an AWS S3 buc More details about the appropriate IAM user properties can found on [doc.gitlab.com](http://doc.gitlab.com/ce/raketasks/backup_restore.html#upload-backups-to-remote-cloud-storage) -For remote backup to selfhosted s3 compatible storage, use `AWS_BACKUP_ENDPOINT`. +For remote backup to self-hosted s3 compatible storage, use `AWS_BACKUP_ENDPOINT`. AWS uploads are performed alongside normal backups, both through the appropriate `app:rake` command and when an automatic backup is performed. diff --git a/docs/container_registry.md b/docs/container_registry.md index 13344067..7e9f5884 100644 --- a/docs/container_registry.md +++ b/docs/container_registry.md @@ -36,7 +36,7 @@ the GitLab installation and the registry are: GitLab needs a certificate ("auth token") to talk to the registry API. The tokens must be provided in the `/certs` directory of your container. You could -use an existing domain ceritificate or create your own with a very long +use an existing domain certificate or create your own with a very long lifetime like this: ```bash @@ -224,7 +224,7 @@ Read more about the individual driver's config options in the > **Warning** GitLab will not backup Docker images that are not stored on the filesystem. Remember to enable backups with your object storage provider if desired. > > If you use **filesystem** as storage driver you need to mount the path from `GITLAB_REGISTRY_DIR` of the GitLab container in the registry container. So both container can access the registry data. -> If you don't change `GITLAB_REGISTRY_DIR` you will find your registry data in the mounted volume from the GitLab Container under `./gitlab/shared/registry`. This don't need to be seprated mounted because `./gitlab` is already mounted in the GitLab Container. If it will be mounted seperated the whole restoring proccess of GitLab backup won't work because gitlab try to create an folder under `./gitlab/shared/registry` /`GITLAB_REGISTRY_DIR` and GitLab can't delete/remove the mount point inside the container so the restoring process of the backup will fail. +> If you don't change `GITLAB_REGISTRY_DIR` you will find your registry data in the mounted volume from the GitLab Container under `./gitlab/shared/registry`. This don't need to be separated mounted because `./gitlab` is already mounted in the GitLab Container. If it will be mounted separated the whole restoring process of GitLab backup won't work because gitlab try to create an folder under `./gitlab/shared/registry` /`GITLAB_REGISTRY_DIR` and GitLab can't delete/remove the mount point inside the container so the restoring process of the backup will fail. > An example how it works is in the `docker-compose`. ### Example for Amazon Simple Storage Service (s3) @@ -265,7 +265,7 @@ storage: - REGISTRY_STORAGE_DELETE_ENABLED=true ``` -Generaly for more information about the configuration of the registry container you can find it under [registry configuration](https://docs.docker.com/registry/configuration). +Generally for more information about the configuration of the registry container you can find it under [registry configuration](https://docs.docker.com/registry/configuration). ## Storage limitations diff --git a/docs/keycloak-idp.md b/docs/keycloak-idp.md index b3aff53c..61f76ce6 100644 --- a/docs/keycloak-idp.md +++ b/docs/keycloak-idp.md @@ -1,4 +1,4 @@ -# Integrate Keycloak as a IDP with GitLab +# Integrate Keycloak as an IDP with GitLab In this document, we will explain how to set up Keycloak and integrate it into GitLab. @@ -73,7 +73,7 @@ Visit the `Users` tab and click on `View all users` to modify the Admin user. Modify the `Email`, `First name` and `Last Name` fields. ![admin-account](images/keycloak-admin-acc.png) -Deploy GitLab, Reddis and PostgreSQL by running the following command: `docker-compose up -d gitlab redis postgresql`. +Deploy GitLab, Redis and PostgreSQL by running the following command: `docker-compose up -d gitlab redis postgresql`. You can now login on the local GitLab instance with with Keycloak on your [local IP](http://localhost:10080). diff --git a/docs/s3_compatible_storage.md b/docs/s3_compatible_storage.md index ca281b70..ed815750 100644 --- a/docs/s3_compatible_storage.md +++ b/docs/s3_compatible_storage.md @@ -1,7 +1,7 @@ GitLab Backup to s3 compatible storage ================================================= -Enables automatic backups to selfhosted s3 compatible storage like minio (https://minio.io/) and others. +Enables automatic backups to self-hosted s3 compatible storage like minio (https://minio.io/) and others. This is an extend of AWS Remote Backups. As explained in [doc.gitlab.com](https://docs.gitlab.com/ce/raketasks/backup_restore.html#upload-backups-to-remote-cloud-storage), it uses [Fog library](http://fog.io) and the module fog-aws. More details on [s3 supported parameters](https://github.com/fog/fog-aws/blob/master/lib/fog/aws/storage.rb) @@ -41,7 +41,7 @@ where: | `AWS_BACKUP_ACCESS_KEY_ID` | AWS access key id. No defaults. | | `AWS_BACKUP_SECRET_ACCESS_KEY` | AWS secret access key. No defaults. | | `AWS_BACKUP_BUCKET` | AWS bucket for backup uploads. No defaults. | -| `AWS_BACKUP_MULTIPART_CHUNK_SIZE` | Enables mulitpart uploads when file size reaches a defined size. See at [AWS S3 Docs](http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) | +| `AWS_BACKUP_MULTIPART_CHUNK_SIZE` | Enables multipart uploads when file size reaches a defined size. See at [AWS S3 Docs](http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) | For more info look at [Available Configuration Parameters](https://github.com/sameersbn/docker-gitlab#available-configuration-parameters).