Fix minor typos and clarify few documentation phrases (#1629)
This commit is contained in:
parent
154249a08f
commit
4673ba7b31
@ -73,7 +73,7 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
|
|||||||
|
|
||||||
* Add the environment variables to the `env-example` if you have any.
|
* Add the environment variables to the `env-example` if you have any.
|
||||||
|
|
||||||
* **MOST IMPORTANTLY** updated the `Documentation`, add as much information.
|
* **MOST IMPORTANTLY** update the `Documentation`, add as much information.
|
||||||
|
|
||||||
* Submit a Pull Request, to the `master` branch.
|
* Submit a Pull Request, to the `master` branch.
|
||||||
|
|
||||||
@ -100,7 +100,7 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
|
|||||||
|
|
||||||
* Search for the image in the [Docker Hub](https://hub.docker.com/search/) and find the source..
|
* Search for the image in the [Docker Hub](https://hub.docker.com/search/) and find the source..
|
||||||
|
|
||||||
*Most of the image in Laradock are offical images, these projects live in other repositories and maintainer by other orgnizations.*
|
*Most of the image in Laradock are offical images, these projects live in other repositories and maintainer by other organizations.*
|
||||||
|
|
||||||
**Note:** Laradock has two base images for (`Workspace` and `php-fpm`, mainly made to speed up the build time on your machine.
|
**Note:** Laradock has two base images for (`Workspace` and `php-fpm`, mainly made to speed up the build time on your machine.
|
||||||
|
|
||||||
|
@ -201,7 +201,7 @@ More [options](https://docs.docker.com/compose/reference/logs/)
|
|||||||
<a name="Install-PHP-Extensions"></a>
|
<a name="Install-PHP-Extensions"></a>
|
||||||
## Install PHP Extensions
|
## Install PHP Extensions
|
||||||
|
|
||||||
Before installing PHP extensions, you have to decide whether you need for the `FPM` or `CLI` because each lives on a different container, if you need it for both you have to edit both containers.
|
Before installing PHP extensions, you have to decide first whether you need `FPM` or `CLI`, because each of them has it's own different container, if you need it for both, you have to edit both containers.
|
||||||
|
|
||||||
The PHP-FPM extensions should be installed in `php-fpm/Dockerfile-XX`. *(replace XX with your default PHP version number)*.
|
The PHP-FPM extensions should be installed in `php-fpm/Dockerfile-XX`. *(replace XX with your default PHP version number)*.
|
||||||
<br>
|
<br>
|
||||||
@ -428,7 +428,7 @@ To learn more about how Docker publishes ports, please read [this excellent post
|
|||||||
|
|
||||||
1) Boot the container `docker-compose up -d jenkins`. To enter the container type `docker-compose exec jenkins bash`.
|
1) Boot the container `docker-compose up -d jenkins`. To enter the container type `docker-compose exec jenkins bash`.
|
||||||
|
|
||||||
2) Go to `http://localhost:8090/` (if you didn't chanhed your default port mapping)
|
2) Go to `http://localhost:8090/` (if you didn't change your default port mapping)
|
||||||
|
|
||||||
3) Authenticate from the web app.
|
3) Authenticate from the web app.
|
||||||
|
|
||||||
@ -971,7 +971,7 @@ docker-compose up -d aws
|
|||||||
|
|
||||||
3 - Access the aws container with `docker-compose exec aws bash`
|
3 - Access the aws container with `docker-compose exec aws bash`
|
||||||
|
|
||||||
4 - To start using eb cli inside the container, initiaze your project first by doing 'eb init'. Read the [aws eb cli](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-configuration.html) docs for more details.
|
4 - To start using eb cli inside the container, initialize your project first by doing 'eb init'. Read the [aws eb cli](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-configuration.html) docs for more details.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -989,7 +989,7 @@ docker-compose up -d grafana
|
|||||||
|
|
||||||
3 - Open your browser and visit the localhost on port **3000** at the following URL: `http://localhost:3000`
|
3 - Open your browser and visit the localhost on port **3000** at the following URL: `http://localhost:3000`
|
||||||
|
|
||||||
4 - Login using the credentials User = `admin` Passwort = `admin`. Change the password in the webinterface if you want to.
|
4 - Login using the credentials User = `admin`, Password = `admin`. Change the password in the web interface if you want to.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1525,7 +1525,7 @@ Quick Setup giude, (we recommend you check their docs)
|
|||||||
<a name="Docker-Sync"></a>
|
<a name="Docker-Sync"></a>
|
||||||
### Workaround B: using d4m-nfs
|
### Workaround B: using d4m-nfs
|
||||||
|
|
||||||
You can use the d4m-nfs solution in 2 ways, one is using the Laradock built it integration, and the other is using the tool separatly. Below is show case of both methods:
|
You can use the d4m-nfs solution in 2 ways, the first is by using the built-in Laradock integration, and the second is using the tool separately. Below is show case of both methods:
|
||||||
|
|
||||||
|
|
||||||
### B.1: using the built in d4m-nfs integration
|
### B.1: using the built in d4m-nfs integration
|
||||||
@ -1630,7 +1630,7 @@ Click on the Docker Icon > Preferences > (remove everything form the list except
|
|||||||
git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
|
git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
|
||||||
```
|
```
|
||||||
|
|
||||||
4) Create (or edit) the file `~/d4m-nfs/etc/d4m-nfs-mounts.txt`, and write the follwing configuration in it:
|
4) Create (or edit) the file `~/d4m-nfs/etc/d4m-nfs-mounts.txt`, and write the following configuration in it:
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
/Users:/Users
|
/Users:/Users
|
||||||
|
@ -161,13 +161,13 @@ We recommend using a Docker version which is newer than 1.13.
|
|||||||
cp env-example .env
|
cp env-example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
You can edit the `.env` file to choose which software's you want to be installed in your environment. You can always refer to the `docker-compose.yml` file to see how those variables are been used.
|
You can edit the `.env` file to choose which software you want to be installed in your environment. You can always refer to the `docker-compose.yml` file to see how those variables have been used.
|
||||||
|
|
||||||
Depending on the host's operating system you may need to change the value given to `COMPOSE_FILE`. When you are running Laradock on Mac OS the correct file separator to use is `:`. When running Laradock from a Windows environment multiple files must be separated with `;`.
|
Depending on the host's operating system you may need to change the value given to `COMPOSE_FILE`. When you are running Laradock on Mac OS the correct file separator to use is `:`. When running Laradock from a Windows environment multiple files must be separated with `;`.
|
||||||
|
|
||||||
By default the containers that will be created have the current directory name as suffix (e.g. `laradock_workspace_1`). This can cause mixture of data inside the container volumes if you use laradock in multiple project. In this case, either read the guide for [multiple projects](#B) or change the variable `COMPOSE_PROJECT_NAME` to something unique like your project name.
|
By default the containers that will be created have the current directory name as suffix (e.g. `laradock_workspace_1`). This can cause mixture of data inside the container volumes if you use laradock in multiple projects. In this case, either read the guide for [multiple projects](#B) or change the variable `COMPOSE_PROJECT_NAME` to something unique like your project name.
|
||||||
|
|
||||||
2 - Build the enviroment and run it using `docker-compose`
|
2 - Build the environment and run it using `docker-compose`
|
||||||
|
|
||||||
In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:
|
In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:
|
||||||
|
|
||||||
@ -175,7 +175,7 @@ In this example we'll see how to run NGINX (web server) and MySQL (database engi
|
|||||||
docker-compose up -d nginx mysql
|
docker-compose up -d nginx mysql
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: The web servers `nginx`, `apache`.. all depend on `php-fpm`, means if you just run, them they will automatically run the `php-fpm` for you, so no need to specify them in the `up` command. If you don't see them running then you may need run them as follow: `docker-compose up -d nginx php-fpm mysql...`.
|
**Note**: All the web server containers `nginx`, `apache` ..etc depends on `php-fpm`, which means if you run any of them, they will automatically launch the `php-fpm` container for you, so no need to explicitly specify it in the `up` command. If you have to do so, you may need to run them as follows: `docker-compose up -d nginx php-fpm mysql`.
|
||||||
|
|
||||||
|
|
||||||
You can select your own combination of containers from [this list](http://laradock.io/introduction/#supported-software-images).
|
You can select your own combination of containers from [this list](http://laradock.io/introduction/#supported-software-images).
|
||||||
@ -205,7 +205,7 @@ docker-compose exec --user=laradock workspace bash
|
|||||||
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
|
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
4 - Update your project configurations to use the database host
|
4 - Update your project configuration to use the database host
|
||||||
|
|
||||||
Open your PHP project's `.env` file or whichever configuration file you are reading from, and set the database host `DB_HOST` to `mysql`:
|
Open your PHP project's `.env` file or whichever configuration file you are reading from, and set the database host `DB_HOST` to `mysql`:
|
||||||
|
|
||||||
|
@ -93,7 +93,7 @@ docker run --name myjenkins -p 8080:8080 -p 50000:50000 --env JAVA_OPTS="-Djava.
|
|||||||
```
|
```
|
||||||
|
|
||||||
# Configuring reverse proxy
|
# Configuring reverse proxy
|
||||||
If you want to install Jenkins behind a reverse proxy with prefix, example: mysite.com/jenkins, you need to add environnement variable `JENKINS_OPTS="--prefix=/jenkins"` and then follow the below procedures to configure your reverse proxy, which will depend if you have Apache ou Nginx:
|
If you want to install Jenkins behind a reverse proxy with prefix, example: mysite.com/jenkins, you need to add environment variable `JENKINS_OPTS="--prefix=/jenkins"` and then follow the below procedures to configure your reverse proxy, which will depend if you have Apache ou Nginx:
|
||||||
- [Apache](https://wiki.jenkins-ci.org/display/JENKINS/Running+Jenkins+behind+Apache)
|
- [Apache](https://wiki.jenkins-ci.org/display/JENKINS/Running+Jenkins+behind+Apache)
|
||||||
- [Nginx](https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+behind+an+NGinX+reverse+proxy)
|
- [Nginx](https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+behind+an+NGinX+reverse+proxy)
|
||||||
|
|
||||||
@ -154,7 +154,7 @@ COPY custom.groovy /usr/share/jenkins/ref/init.groovy.d/custom.groovy
|
|||||||
## Preinstalling plugins
|
## Preinstalling plugins
|
||||||
|
|
||||||
You can rely on the `install-plugins.sh` script to pass a set of plugins to download with their dependencies.
|
You can rely on the `install-plugins.sh` script to pass a set of plugins to download with their dependencies.
|
||||||
Use plugin artifact ID, whithout `-plugin` extension, and append the version if needed separated by `:`.
|
Use plugin artifact ID, without `-plugin` extension, and append the version if needed separated by `:`.
|
||||||
Dependencies that are already included in the Jenkins war will only be downloaded if their required version is newer than the one included.
|
Dependencies that are already included in the Jenkins war will only be downloaded if their required version is newer than the one included.
|
||||||
|
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user