Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docker compose update #2789

Merged
merged 21 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
f70b574
feat(docker): update Elasticsearch and OpenSearch semantics, refactor…
Aaron-Ritter Dec 7, 2023
49cc2f2
Merge branch 'master' into docker-compose-update
Aaron-Ritter Dec 7, 2023
59a616f
Merge branch 'master' into docker-compose-update
Aaron-Ritter Dec 7, 2023
f5ca32c
Merge remote-tracking branch 'origin/master' into docker-compose-update
Aaron-Ritter Dec 12, 2023
17dcce7
refactor(docker): enhanced documentation for docker compose setup and…
Aaron-Ritter Dec 12, 2023
d3948cd
refactor(docker): enhanced documentation for docker compose setup
Aaron-Ritter Dec 13, 2023
6eb7fd4
refactor(docker): enhanced documentation for docker compose setup
Aaron-Ritter Dec 13, 2023
f703689
Merge remote-tracking branch 'origin/master' into docker-compose-update
Aaron-Ritter Dec 13, 2023
bab3a45
feat(docker): add concrete build example
Aaron-Ritter Dec 27, 2023
c5699ea
refactor(docker): further clarify build example commands
Aaron-Ritter Dec 27, 2023
d67fd55
Merge branch 'FusionAuth:master' into docker-compose-update
Aaron-Ritter Dec 28, 2023
e4fce45
refactor(docker): update with review feedback
Aaron-Ritter Jan 4, 2024
bd14425
refactor(docker): update with review feedback
Aaron-Ritter Jan 4, 2024
5437994
Revert "refactor(docker): update with review feedback"
Aaron-Ritter Jan 4, 2024
0367306
refactor(docker): update with review feedback
Aaron-Ritter Jan 4, 2024
7803845
Revert "refactor(docker): update with review feedback"
Aaron-Ritter Jan 4, 2024
cc4d6b2
Merge remote-tracking branch 'origin/master' into docker-compose-update
Aaron-Ritter Jan 4, 2024
cf82cd9
refactor(docker): update with review feedback
Aaron-Ritter Jan 4, 2024
b003f8f
refactor(docker): change all docker compose commands to V2
Aaron-Ritter Jan 4, 2024
3726bd4
refactor(docker): additional review changes
Aaron-Ritter Jan 4, 2024
5e9d76a
refactor(docker): changing Dockerfile code syntax, using "Docker Comp…
vcampitelli Jan 31, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion astro/src/content/docs/_shared/_elasticsearch-ram.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The RAM required by Elasticsearch depends on your login volume and user/entity counts. If you expect to have a few logins per minute and only a few thousand users/entities, `1GB-2GB` of RAM will be sufficient. If you have more users/entities as well as logins, please size up accordingly. We recommend running load tests of FusionAuth to help determine the amount of RAM that is required for your needs.
The RAM required by Elasticsearch or OpenSearch depends on your login volume and user/entity counts. If you expect to have a few logins per minute and only a few thousand users/entities, `1GB-2GB` of RAM will be sufficient. If you have more users/entities as well as logins, please size up accordingly. We recommend running load tests of FusionAuth to help determine the amount of RAM that is required for your needs.
2 changes: 1 addition & 1 deletion astro/src/content/docs/_shared/_elasticsearch-version.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Versions `>=` 7.6.1 and `<=` 7.17.x are currently supported. Later versions may work as well but may not have been tested for compatibility.
Elasticsearch Versions `>=` 7.6.1 and `<=` 7.17.x are currently supported. Later versions may work as well but may not have been tested for compatibility.

OpenSearch version 2.x should also function properly with FusionAuth version `>= 1.42.0`.
6 changes: 3 additions & 3 deletions astro/src/content/docs/_shared/_upgrade-using-docker.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
To upgrade FusionAuth when running with `docker-compose`:
To upgrade FusionAuth when running with `docker compose`:

1. Stop the instance: `docker-compose down`.
1. Stop the instance: `docker compose down`.
2. Modify the `docker-compose.yml` file to point to the version of FusionAuth you want. You can see [available tags](https://hub.docker.com/r/fusionauth/fusionauth-app).
3. Start it up: `docker-compose up`.
3. Start it up: `docker compose up -d`.
4. Log in to the administrative UI.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Edit these files as needed. The stock `.env` file will contain the following val
title="The .env file" />

```shell title="Starting FusionAuth"
docker compose up
docker compose up -d
docker compose logs -f
```

Now you can visit `http://localhost:9011` and configure FusionAuth.
Expand Down
325 changes: 40 additions & 285 deletions astro/src/content/docs/get-started/download-and-install/docker.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import DataFieldDataTypeChanges from 'src/content/docs/_shared/_data-field-data-
As of version 1.16.0, FusionAuth has the concept of a search engine type. There are two valid values:

* `database`
* `elasticsearch`
* `elasticsearch` (for Elasticsearch or OpenSearch)

They have different [strengths and limitations](/docs/get-started/core-concepts/users#user-search). This tutorial walks you through the process of changing your FusionAuth search engine. Reasons for doing so vary. You may be simplifying your deployment strategy with the database search engine. Or perhaps you need the advanced searching options of Elasticsearch after your application has grown. Either way, it's an easy switch.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ extra_hosts:
* Run the following commands in a new terminal in the folder to restart FusionAuth with mail capabilities. **Be warned:** This might reset your existing FusionAuth database.

```
docker-compose down && docker-compose up;
docker compose down && docker compose up;
```
</Aside>

Expand Down
6 changes: 6 additions & 0 deletions astro/src/content/json/exampleapps.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@
"description": "Examples of Kickstart, a way to configure FusionAuth at startup",
"language": "config"
},
{
"url": "https://github.com/FusionAuth/fusionauth-example-docker-compose",
"name": "Docker Compose",
"description": "Docker Compose examples, different ways to configure and run FusionAuth",
"language": "config"
},
{
"url": "https://github.com/FusionAuth/fusionauth-theme-helper",
"name": "Theme Helper",
Expand Down
2 changes: 1 addition & 1 deletion astro/src/content/quickstarts/quickstart-dotnet-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ This will start three containers, one each for FusionAuth, Postgres, and Elastic
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart). When FusionAuth starts for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to your specified state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down
2 changes: 1 addition & 1 deletion astro/src/content/quickstarts/quickstart-dotnet-web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ docker compose up -d
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart) When FusionAuth comes up for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down
2 changes: 1 addition & 1 deletion astro/src/content/quickstarts/quickstart-golang-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ docker compose up -d
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart). When FusionAuth comes up for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker-compose down -v`, then re-run `docker-compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down
6 changes: 3 additions & 3 deletions astro/src/content/quickstarts/quickstart-golang-web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ variables configuration file (.env). Assuming you have Docker installed on your
FusionAuth up on your machine with:

```
docker-compose up -d
docker compose up -d
```

This will start three containers, once each for FusionAuth, Postgres, and Elastic.
Expand All @@ -71,8 +71,8 @@ When FusionAuth comes up for the first time, it will look at the `kickstart/kick
configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by
executing `docker-compose down -v`, then re-run `docker-compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by
executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be configured with these settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ docker compose up -d
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart). When FusionAuth comes up for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker-compose down -v`, then re-run `docker-compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down Expand Up @@ -429,7 +429,7 @@ You can always pull down a complete running application and compare what's diffe
```
git clone https://github.com/FusionAuth/fusionauth-quickstart-java-springboot-api.git
cd fusionauth-quickstart-java-springboot-api
docker-compose up -d
docker compose up -d
cd complete-app
./mvnw package spring-boot:run
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ When FusionAuth comes up for the first time, it will look at the `kickstart/kick
configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by
executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ When FusionAuth comes up for the first time, it will look at the `kickstart/kick
configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by
executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ When FusionAuth comes up for the first time, it will look at the `kickstart/kick
configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by
executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ docker compose up -d
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/v1/tech/installation-guide/kickstart). When FusionAuth comes up for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,15 @@ You'll find a Docker Compose file `docker-compose.yml` and an environment variab
Assuming you have Docker installed, you can start FusionAuth on your machine with the following.

```
docker-compose up -d
docker compose up -d
```

This will start three containers, one each for FusionAuth, Postgres, and Elasticsearch.

Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart). When FusionAuth starts for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to your specified state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by `docker-compose` by executing `docker-compose down -v`, then rerun `docker-compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by `docker-compose` by executing `docker compose down -v`, then rerun `docker compose up -d`.
</Aside>

FusionAuth will be configured with these settings:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ docker compose up -d
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart). When FusionAuth comes up for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker-compose down -v`, then re-run `docker-compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down Expand Up @@ -397,7 +397,7 @@ You can always pull down a complete running application and compare what's diffe
```
git clone https://github.com/FusionAuth/fusionauth-quickstart-ruby-on-rails-api.git
cd fusionauth-quickstart-ruby-on-rails-api
docker-compose up -d
docker compose up -d
cd complete-application
bundle install
bundle e rails s -p 4001
Expand Down
4 changes: 2 additions & 2 deletions astro/src/content/quickstarts/quickstart-ruby-rails-web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ docker compose up -d
Here you are using a bootstrapping feature of FusionAuth, called [Kickstart](/docs/get-started/download-and-install/development/kickstart). When FusionAuth comes up for the first time, it will look at the `kickstart/kickstart.json` file and configure FusionAuth to a certain initial state.

<Aside type="note">
If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing `docker compose down -v`, then re-run `docker compose up -d`.
</Aside>

FusionAuth will be initially configured with these settings:
Expand Down Expand Up @@ -280,7 +280,7 @@ You can always pull down a complete running application and compare what's diffe
{(value) => (
<Code lang="shell" code={`git clone https://github.com/FusionAuth/fusionauth-quickstart-ruby-on-rails-web.git
cd fusionauth-quickstart-ruby-on-rails-web
docker-compose up -d
docker compose up -d
cd complete-app
bundle install
OP_SECRET_KEY=${value} bundle exec rails s`}/>
Expand Down
Loading