Update README.md

This commit is contained in:
Lepetit Paul 2017-02-17 10:57:22 +01:00 committed by GitHub
parent 0f12f89a91
commit 3b554b8e51

View File

@ -39,8 +39,8 @@ OCS Inventory NG includes the packet deployment functionality to be sure that al
Starting a **OCSInventory container** is simple: Starting a **OCSInventory container** is simple:
Clone this repository : Clone this repository :
> sudo git clone https://github.com/OCSInventory-NG/OCSInventory-Docker-Image.git > sudo git clone https://github.com/OCSInventory-NG/OCSInventory-Docker-Image.git <br>
> cd OCSInventory-Docker-Image > cd OCSInventory-Docker-Image <br>
*The following command uses the **default values**.* *The following command uses the **default values**.*
@ -62,8 +62,8 @@ Clone this repository :
Enter the directory you just clone, and run the setup.sh script Enter the directory you just clone, and run the setup.sh script
> cd OCSInventory-Docker-Image > cd OCSInventory-Docker-Image <br>
> sudo bash setup.sh > sudo bash setup.sh <br>
Follow the steps, the script will do the work for you Follow the steps, the script will do the work for you
@ -71,11 +71,11 @@ Follow the steps, the script will do the work for you
Use the following environmental variables to connect your MySQL Server. Use the following environmental variables to connect your MySQL Server.
> OCS_DBNAME= *(Name of your database)* > OCS_DBNAME= *(Name of your database)* <br>
> OCS_DBSERVER_READ= *(Database Server)* > OCS_DBSERVER_READ= *(Database Server)* <br>
> OCS_DBSERVER_WRITE=*(Database Server)* > OCS_DBSERVER_WRITE=*(Database Server)* <br>
> OCS_DBUSER= *(User database)* > OCS_DBUSER= *(User database)* <br>
> OCS_DBPASS= *(User password)* > OCS_DBPASS= *(User password)* <br>
---------- ----------
@ -107,18 +107,18 @@ Create a data directory on your host system:
Start your OCSInventory container like this: Start your OCSInventory container like this:
> sudo docker run \ > sudo docker run \ <br>
> -p 80:80 \ > -p 80:80 \ <br>
> --name myocsinventory \ > --name myocsinventory \ <br>
> -v /my/own/datadir:/data/save/ocsinventory \ > -v /my/own/datadir:/data/save/ocsinventory \ <br>
> -e OCS_DBNAME=ocsweb \ > -e OCS_DBNAME=ocsweb \ <br>
> -e OCS_DBSERVER_READ=localhost \ > -e OCS_DBSERVER_READ=localhost \ <br>
> -e OCS_DBSERVER_WRITE=localhost \ > -e OCS_DBSERVER_WRITE=localhost \ <br>
> -e OCS_DBUSER=ocs \ > -e OCS_DBUSER=ocs \ <br>
> -e OCS_DBPASS=ocs \ > -e OCS_DBPASS=ocs \ <br>
> -itd \ > -itd \ <br>
> ocsinventory/ocsinventory-docker-image:master \ > ocsinventory/ocsinventory-docker-image:master \ <br>
> bash > bash <br>
The option -v /my/own/datadir:/data/save/ocsinventory mounts the /my/own/datadir directory from the host system as /data/save/ocsinventory inside the container. The option -v /my/own/datadir:/data/save/ocsinventory mounts the /my/own/datadir directory from the host system as /data/save/ocsinventory inside the container.
@ -132,20 +132,20 @@ Create a volume:
Run your container: Run your container:
> sudo docker run \ > sudo docker run \ <br>
> -p 80:80 \ > -p 80:80 \ <br>
> --name name-container \ > --name name-container \ <br>
> -v ocsdata:/usr/share/ocsinventory-reports/ \ > -v ocsdata:/usr/share/ocsinventory-reports/ \ <br>
> -v ocsdata:/etc/ocsinventory-reports/ \ > -v ocsdata:/etc/ocsinventory-reports/ \ <br>
> -v ocsdata:/var/lib/ocsinventory-reports/ \ > -v ocsdata:/var/lib/ocsinventory-reports/ \ <br>
> -e OCS_DBNAME=ocsweb \ > -e OCS_DBNAME=ocsweb \ <br>
> -e OCS_DBSERVER_READ=localhost \ > -e OCS_DBSERVER_READ=localhost \ <br>
> -e OCS_DBSERVER_WRITE=localhost \ > -e OCS_DBSERVER_WRITE=localhost \ <br>
> -e OCS_DBUSER=ocs \ > -e OCS_DBUSER=ocs \ <br>
> -e OCS_DBPASS=ocs \ > -e OCS_DBPASS=ocs \ <br>
> -itd \ > -itd \ <br>
> ocsinventory/ocsinventory-docker-image:master \ > ocsinventory/ocsinventory-docker-image:master \ <br>
> bash > bash <br>
It is advisable to keep the directories mentioned in the example: It is advisable to keep the directories mentioned in the example:
@ -157,12 +157,12 @@ They contain the necessary information for a proper server and web interface fun
## Contributing ## Contributing
Fork it! 1. Fork it!
Create your feature branch: git checkout -b my-new-feature 2. Create your feature branch: git checkout -b my-new-feature
Add your changes: git add folder/file1.php 3. Add your changes: git add folder/file1.php
Commit your changes: git commit -m 'Add some feature' 4. Commit your changes: git commit -m 'Add some feature'
Push to the branch: git push origin my-new-feature 5. Push to the branch: git push origin my-new-feature
Submit a pull request ! 6. Submit a pull request !
## License ## License