Update README.md

This commit is contained in:
Lepetit Paul 2017-02-22 14:36:56 +01:00 committed by GitHub
parent 613779ac9a
commit 433aeed2c4

138
README.md
View File

@ -1,91 +1,87 @@
![Logo-OCS](http://cdn.ocsinventory-ng.org/common/banners/banner300px.png)
## Some Links
- [ASK question](http://ask.ocsinventory-ng.org")
- [Website](http://www.ocsinventory-ng.org/?utm_source=github-ocs)
- [Github](https://github.com/OCSInventory-NG)
- [Support](https://www.factorfx.com/ocs-en)
<p align="center">
<img src="https://cdn.ocsinventory-ng.org/common/banners/banner660px.png" height=300 width=660 alt="Banner">
</p>
<h1 align="center">OCS Inventory</h1>
<p align="center">
<b>Some Links:</b><br>
<a href="http://ask.ocsinventory-ng.org">Ask question</a> |
<a href="#COMMING_SOON_STAY_CONNECTED">Installation</a> |
<a href="http://www.ocsinventory-ng.org/?utm_source=github-ocs">Website</a> |
<a href="https://www.factorfx.com/ocs-en">Support</a>
</p>
<p align='justify'>
OCS (Open Computers and Software Inventory Next Generation) is an assets management and deployment solution. OCS (Open Computers and Software Inventory Next Generation) is an assets management and deployment solution.
Since 2001, OCS Inventory NG has been looking for making software and hardware more powerful. Since 2001, OCS Inventory NG has been looking for making software and hardware more powerful.
OCS Inventory NG asks its agents to know the software and hardware composition of every computer or server. OCS Inventory NG asks its agents to know the software and hardware composition of every computer or server.
</p>
----------
## Assets management
<h2 align="center">Assets management</h2>
<p align='justify'>
Since 2001, OCS Inventory NG has been looking for making software and hardware more powerful. OCS Inventory NG asks its agents to know the software and hardware composition of every computer or server. OCS Inventory also ask to discover networks elements which cant receive an agent. Since the version 2.0, OCS Inventory NG take in charge the SNMP scans functionality. Since 2001, OCS Inventory NG has been looking for making software and hardware more powerful. OCS Inventory NG asks its agents to know the software and hardware composition of every computer or server. OCS Inventory also ask to discover networks elements which cant receive an agent. Since the version 2.0, OCS Inventory NG take in charge the SNMP scans functionality.
This functionalitys main goal is to complete the data retrieved from the IP Discover scan. These SNMP scans will allow you to add a lot more informations from your network devices : printers, scanner, routers, computer without agents, … This functionalitys main goal is to complete the data retrieved from the IP Discover scan. These SNMP scans will allow you to add a lot more informations from your network devices : printers, scanner, routers, computer without agents, …
</p>
<h2 align="center">Deployment</h2> ----------
<p align='justify'>
## Deployment
OCS Inventory NG includes the packet deployment functionality to be sure that all of the softwares environments which are on the network are the same. From the central management server, you can send the packets which will be downloaded with HTTP/HTTPS and launched by the agent on clients computer. The OCS deployment is configured to make the packets less impactable on the network. OCS is used as a deployment tool on IT stock of more 100 000 devices. OCS Inventory NG includes the packet deployment functionality to be sure that all of the softwares environments which are on the network are the same. From the central management server, you can send the packets which will be downloaded with HTTP/HTTPS and launched by the agent on clients computer. The OCS deployment is configured to make the packets less impactable on the network. OCS is used as a deployment tool on IT stock of more 100 000 devices.
</p>
<br /> ----------
## Installation ## Installation
###Start your OCSInventory container #### Start your OCSInventory container
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 <br> > sudo git clone https://github.com/OCSInventory-NG/OCSInventory-Docker-Image.git
> cd OCSInventory-Docker-Image <br> > cd OCSInventory-Docker-Image
*The following command uses the **default values**.* *The following command uses the **default values**.*
> sudo docker run \ > sudo docker run \
> -p 80:80 \ > -p 80:80 \
> --name myocsinventory \ > --name myocsinventory \
> -e OCS_DBNAME=ocsweb \ > -e OCS_DBNAME=ocsweb \
> -e OCS_DBSERVER_READ=localhost \ > -e OCS_DBSERVER_READ=localhost \
> -e OCS_DBSERVER_WRITE=localhost \ > -e OCS_DBSERVER_WRITE=localhost \
> -e OCS_DBUSER=ocs \ > -e OCS_DBUSER=ocs \
> -e OCS_DBPASS=ocs \ > -e OCS_DBPASS=ocs \
> -itd \ > -itd \
> ocsinventory/ocsinventory-docker-image:latest \ <br> > ocsinventory/ocsinventory-docker-image:master \
> bash > bash
---------- ----------
###Use setup.sh to start you OCSInventory container ### Use setup.sh to start you OCSInventory container
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 <br> > cd OCSInventory-Docker-Image
> sudo bash setup.sh <br> > sudo bash setup.sh
Follow the steps, the script will do the work for you Follow the steps, the script will do the work for you
###Environmental variables options ### Environmental variables options
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)* <br> > OCS_DBNAME= *(Name of your database)*
> OCS_DBSERVER_READ= *(Database Server)* <br> > OCS_DBSERVER_READ= *(Database Server)*
> OCS_DBSERVER_WRITE=*(Database Server)* <br> > OCS_DBSERVER_WRITE=*(Database Server)*
> OCS_DBUSER= *(User database)* <br> > OCS_DBUSER= *(User database)*
> OCS_DBPASS= *(User password)* <br> > OCS_DBPASS= *(User password)*
---------- ----------
###Using Docker container ### Using Docker container
If you want to run your OCSInventory within a MYSQL docker container, simply start your database server before starting your OCSInventory container. More information here for MYSQL container or use our **[Stack OCSInventory](https://github.com/OCSInventory-NG/OCSInventory-Docker-Stack.git)**. If you want to run your OCSInventory within a MYSQL docker container, simply start your database server before starting your OCSInventory container. More information here for MYSQL container or use our **[Stack OCSInventory](https://github.com/OCSInventory-NG/OCSInventory-Docker-Stack.git)**.
---------- ----------
###Container shell access and viewing container logs ### Container shell access and viewing container logs
The docker exec command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your OCSInventory container: The docker exec command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your OCSInventory container:
@ -97,7 +93,7 @@ You can access to the container logs through the following Docker command:
---------- ----------
###Create a volume back up from the docker's host ### Create a volume back up from the docker's host
The Docker documentation is a good starting point for understanding the different storage options and give advice in this area. We will simply show the basic procedure here: The Docker documentation is a good starting point for understanding the different storage options and give advice in this area. We will simply show the basic procedure here:
@ -107,24 +103,24 @@ Create a data directory on your host system:
Start your OCSInventory container like this: Start your OCSInventory container like this:
> sudo docker run \ <br> > sudo docker run \
> -p 80:80 \ <br> > -p 80:80 \
> --name myocsinventory \ <br> > --name myocsinventory \
> -v /my/own/datadir:/data/save/ocsinventory \ <br> > -v /my/own/datadir:/data/save/ocsinventory \
> -e OCS_DBNAME=ocsweb \ <br> > -e OCS_DBNAME=ocsweb \
> -e OCS_DBSERVER_READ=localhost \ <br> > -e OCS_DBSERVER_READ=localhost \
> -e OCS_DBSERVER_WRITE=localhost \ <br> > -e OCS_DBSERVER_WRITE=localhost \
> -e OCS_DBUSER=ocs \ <br> > -e OCS_DBUSER=ocs \
> -e OCS_DBPASS=ocs \ <br> > -e OCS_DBPASS=ocs \
> -itd \ <br> > -itd \
> ocsinventory/ocsinventory-docker-image:latest \ <br> > ocsinventory/ocsinventory-docker-image:master \
> bash <br> > bash
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.
---------- ----------
###Mount a volume as a data volume ### Mount a volume as a data volume
Create a volume: Create a volume:
@ -132,20 +128,20 @@ Create a volume:
Run your container: Run your container:
> sudo docker run \ <br> > sudo docker run \
> -p 80:80 \ <br> > -p 80:80 \
> --name name-container \ <br> > --name name-container \
> -v ocsdata:/usr/share/ocsinventory-reports/ \ <br> > -v ocsdata:/usr/share/ocsinventory-reports/ \
> -v ocsdata:/etc/ocsinventory-reports/ \ <br> > -v ocsdata:/etc/ocsinventory-reports/ \
> -v ocsdata:/var/lib/ocsinventory-reports/ \ <br> > -v ocsdata:/var/lib/ocsinventory-reports/ \
> -e OCS_DBNAME=ocsweb \ <br> > -e OCS_DBNAME=ocsweb \
> -e OCS_DBSERVER_READ=localhost \ <br> > -e OCS_DBSERVER_READ=localhost \
> -e OCS_DBSERVER_WRITE=localhost \ <br> > -e OCS_DBSERVER_WRITE=localhost \
> -e OCS_DBUSER=ocs \ <br> > -e OCS_DBUSER=ocs \
> -e OCS_DBPASS=ocs \ <br> > -e OCS_DBPASS=ocs \
> -itd \ <br> > -itd \
> ocsinventory/ocsinventory-docker-image:latest \ <br> > ocsinventory/ocsinventory-docker-image:master \
> bash <br> > bash
It is advisable to keep the directories mentioned in the example: It is advisable to keep the directories mentioned in the example: