Skip to content

Commit d28fd7f

Browse files
Apply suggestions from code review
Co-authored-by: sofietoft <[email protected]>
1 parent 65c54dc commit d28fd7f

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

14/umbraco-cms/fundamentals/setup/install/running-umbraco-on-docker-locally.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: "Running Umbraco on docker locally using docker compose"
44

55
# Running Umbraco in Docker using Docker Compose
66

7-
To aid in developing Umbraco with additional services, the templates can provide the requisite files to run Umbraco with a SQL Server database in Docker.
8-
This setup is designed to be used for local development, and not for production.
7+
To aid in developing Umbraco with additional services, the templates can provide the requisite files to run Umbraco with an SQL Server database in Docker. This setup is designed to be used for local development, and not for production.
98

109
## Prerequisites
1110

@@ -44,54 +43,56 @@ The final folder structure looks like this:
4443
* MyDockerProject
4544
* Typical project files
4645
* DockerFile
47-
* .dockerignore
48-
* .env
46+
* `.dockerignore`
47+
* `.env`
4948
* Database
5049
* DockerFile
51-
* healthcheck.sh
52-
* setup.sql
53-
* startup.sh
54-
* docker-compose.yml
50+
* `healthcheck.sh`
51+
* `setup.sql`
52+
* `startup.sh`
53+
* `docker-compose.yml`
5554

56-
As you can see the project now includes docker files for both Umbraco itself and the SQL server database, as well as some additional scripts to launch and configure the database.
55+
The project now includes docker files for both Umbraco and the SQL server database.
5756

58-
It also includes a .env file with the password for the database.
57+
It also includes additional scripts to launch and configure the database and a `.env` file with the database password.
5958

6059
## Running
6160

62-
To run the project run the `docker compose up` command from the root of the project, same folder as `docker-compose.yml`.
61+
To run the project use the `docker compose up` command in the root of the project files where the `docker-compose.yml` is.
6362

64-
This command will build both the Umbraco and Sql Server images and launch them in the correct order, after a while the site will have booted and you can navigate to it in your browser like nomral on `http://localhost:44372/`
63+
This command will build both the Umbraco and SQL Server images and launch them in the correct order. When the site is booted, access it in your browser on `http://localhost:44372/`.
6564

6665
### Useful commands
6766

68-
There is some useful commands you can use to manage the docker containers:
67+
There are some useful commands you can use to manage the docker containers:
6968

70-
* `docker compose down --volumes` This will delete your containers and the volumes they use, this is useful if you want to start from scratch.
69+
* `docker compose down --volumes`: Delete your containers and the volumes they use. This is useful if you want to start from scratch.
7170

7271
{% hint style="warning" %}
73-
This delete your database and all data in it, so be careful with this command.
72+
Be careful with this command, as it deletes your database and all data in it.
7473
{% endhint %}
7574

76-
* `docker compose up --build` This will rebuild the images and start the containers, this is useful if you have made changes to the project and want to see them reflected in the running site.
77-
* `docker compose watch` This will start the containers and watch the default models folder, this means that if the project uses source code models builder the images automatically rebuilds and restarts when you change the models.
75+
* `docker compose up --build`: Rebuild the images and start the containers. This is useful if you have made changes to the project and want to see them reflected on the running site.
76+
* `docker compose watch`: Start the containers and watch the default models folder. This means that if the project uses a source-code models builder the images are automatically rebuilt and restarts when you change the models.
7877

7978
## Details
8079

8180
The docker compose file uses bind mounts for the following folders:
8281

83-
* /wwwroot/media
84-
* /wwwroot/scripts
85-
* /wwwroot/css
86-
* /Views
87-
* /models
82+
* `/wwwroot/media`
83+
* `/wwwroot/scripts`
84+
* `/wwwroot/css`
85+
* `/Views`
86+
* `/models`
8887

89-
This is bad for production, however, for local development this means that the files necessary for development are available from outside the container in your IDE allowing you to effectively develop even though the project is running in docker.
88+
This is not meant to be used in production.
89+
90+
For local development, however, this means that the files necessary for development are available from outside the container in your IDE. This allows development even though the project is running in docker.
9091

9192
## Template options
9293

9394
The `umbraco-compose` template has a few options that can be used to customize the setup:
9495

95-
* -P or --project-name: The name of the project, this is required and used to set the correct paths in the docker-compose file.
96-
* -dbpw or --DatabasePasswor: Used to specify the database password, this is stored in the .env file, defaults to: Password1234
97-
* -p or --Port: Used to specify the port the site will run on, defaults to 44372
96+
* `-P` or `--project-name`: The name of the project. This is required and used to set the correct paths in the docker-compose file.
97+
* `-dbpw` or `--DatabasePasswor`: Used to specify the database password. This is stored in the `.env` file and defaults to: `Password1234`.
98+
* `-p` or `--Port`: Used to specify the port the site will run on. Defaults to `44372`.

0 commit comments

Comments
 (0)