<commit_before>= Docker
:page-sidebar: am_2_x_sidebar
:page-permalink: am/2.x/am_installguide_docker.html
:page-folder: am/installation-guide
:docker-image-src: https://raw.githubusercontent.com/gravitee-io/gravitee-docker/master/images
:github-repo: https://github.com/gravitee-io/graviteeio-access-management/tree/master/docker
:docker-hub: https://hub.docker.com/r/graviteeio

IMPORTANT: We assume that you are familiar with Docker terms. +
To run our official images, you must start by installing https://docs.docker.com/installation/[Docker]

Gravitee.io Access Management Docker images are https://hub.docker.com/u/graviteeio/[available on Docker Hub].
You could find all https://github.com/gravitee-io/graviteeio-access-management/tree/master/docker/[Dockerfiles on GitHub].

We provide a complete set of images.

== Images
|===
|Image name |Source |Version |Base

|{docker-hub}/am-gateway/[graviteeio/am-gateway]
|{github-repo}/gateway/[images/am-gateway]
|latest
|https://hub.docker.com/_/alpine/[alpine:3.8]

|{docker-hub}/am-management-api/[graviteeio/am-management-api]
|{github-repo}/management-api/[images/am-management-api]
|latest
|https://hub.docker.com/_/alpine/[alpine:3.8]

|{docker-hub}/am-management-ui/[graviteeio/am-management-ui]
|{github-repo}/management-ui/[images/am-webui]
|latest
|https://hub.docker.com/_/alpine/[nginx:1.15-alpine]

|===


== Docker Compose

=== Running AM manually
You can launch a complete environment using our ready-to-use docker-compose file. It includes Gravitee.io Access Management + MongoDB.

[source, shell]
....
# Download required Docker Compose files
$ mkdir -p config
$ curl -L https://raw.githubusercontent.com/gravitee-io/graviteeio-access-management/master/docker/compose/docker-compose.yml -o "docker-compose.yml"
$ cd config && { curl -O https://raw.githubusercontent.com/gravitee-io/graviteeio-access-management/master/docker/compose/config/constants.json ; cd -; }
$ cd config && { curl -O https://raw.githubusercontent.com/gravitee-io/graviteeio-access-management/master/docker/compose/config/nginx.conf ; cd -; }

# (Optional step: pull to ensure that you are running latest images)
$ docker-compose -f docker-compose.yml pull

# And run...
$ docker-compose -f docker-compose.yml up
....

When all components are started, you can do a quick test to see if everything is ok by checking these urls:

|===
|Image |URL

|{docker-hub}/am-gateway/[graviteeio/am-gateway]
|http://localhost/am/

|{docker-hub}/am-management-api/[graviteeio/am-management-api]
|http://localhost/am/management

|{docker-hub}/am-webui/[graviteeio/am-management-ui]
|http://localhost/am/ui/

|===

Once done, you're now ready to play with Gravitee.io Access Management, so let's take a look to the <<gravitee-quickstart, Quickstart guide>>.

=== Running AM in a single line

If you are impatient to play with Gravitee.io Access Management (something we can understand!), you can also run the following command line:

[source, shell]
....
$ curl -L http://bit.ly/graviteeio-am | bash
....

NOTE: You can change default http port (80), by passing -s <port> argument to the curl command.

[source, shell]
....
$ curl -L http://bit.ly/graviteeio-am | bash -s 8080
....

Validation steps are the same as the previous section.<commit_msg>Update documentation to run Gravitee.io AM using docker<commit_after>= Docker
:page-sidebar: am_2_x_sidebar
:page-permalink: am/2.x/am_installguide_docker.html
:page-folder: am/installation-guide
:docker-image-src: https://raw.githubusercontent.com/gravitee-io/gravitee-docker/master/images
:github-repo: https://github.com/gravitee-io/graviteeio-access-management/tree/master/docker
:docker-hub: https://hub.docker.com/r/graviteeio

IMPORTANT: We assume that you are familiar with Docker terms. +
To run our official images, you must start by installing https://docs.docker.com/installation/[Docker]

Gravitee.io Access Management Docker images are https://hub.docker.com/u/graviteeio/[available on Docker Hub].
You could find all https://github.com/gravitee-io/graviteeio-access-management/tree/master/docker/[Dockerfiles on GitHub].

We provide a complete set of images.

== Images
|===
|Image name |Source |Version |Base

|{docker-hub}/am-gateway/[graviteeio/am-gateway]
|{github-repo}/gateway/[images/am-gateway]
|latest
|https://hub.docker.com/_/alpine/[alpine:3.8]

|{docker-hub}/am-management-api/[graviteeio/am-management-api]
|{github-repo}/management-api/[images/am-management-api]
|latest
|https://hub.docker.com/_/alpine/[alpine:3.8]

|{docker-hub}/am-management-ui/[graviteeio/am-management-ui]
|{github-repo}/management-ui/[images/am-webui]
|latest
|https://hub.docker.com/_/alpine/[nginx:1.15-alpine]

|===


== Docker Compose

=== Running AM manually
You can launch a complete environment using our ready-to-use docker-compose file. It includes Gravitee.io Access Management + MongoDB.

[source, shell]
....
# Download required Docker Compose files
$ mkdir -p config
$ curl -L -O https://raw.githubusercontent.com/gravitee-io/graviteeio-access-management/master/docker/compose/docker-compose.yml
$ cd config && { curl -O https://raw.githubusercontent.com/gravitee-io/graviteeio-access-management/master/docker/compose/config/.env ; cd -; }
$ cd config && { curl -O https://raw.githubusercontent.com/gravitee-io/graviteeio-access-management/master/docker/compose/config/nginx.conf ; cd -; }

# (Optional step: pull to ensure that you are running latest images)
$ docker-compose pull

# And run...
$ docker-compose up
....

When all components are started, you can do a quick test to see if everything is ok by checking these urls:

|===
|Image |URL

|{docker-hub}/am-gateway/[graviteeio/am-gateway]
|http://localhost/am/

|{docker-hub}/am-management-api/[graviteeio/am-management-api]
|http://localhost/am/management

|{docker-hub}/am-webui/[graviteeio/am-management-ui]
|http://localhost/am/ui/

|===

If you want to run Gravitee.io AM with a different version or if you want to want to change the default port, you can run
`docker-compose`as follow:

[source, shell]
....
$ GIO_AM_VERSION=2 NGINX_PORT=18000 docker-compose up
....

Once done, you're now ready to play with Gravitee.io Access Management, so let's take a look to the <<gravitee-quickstart, Quickstart guide>>.

=== Running AM in a single line

If you are impatient to play with Gravitee.io Access Management (something we can understand!), you can also run the following command line:

[source, shell]
....
$ curl -L http://bit.ly/graviteeio-am | bash
....

NOTE: You can change default http port (80), by passing -s <port> argument to the curl command.

[source, shell]
....
$ curl -L http://bit.ly/graviteeio-am | bash -s 8080
....

Validation steps are the same as the previous section.
{'fraction_non_alphanumeric': 0.1449747998814112, 'fraction_numerical': 0.005336495701156241, 'mean_word_length': 4.300078554595443, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 24, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7248643', 'n_tokens_mistral': 2399, 'n_tokens_neox': 2237, 'n_words': 564}