diff --git a/README.md b/README.md index 0cba5e905a..e3118471d7 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@ ## Description -OpenNebula is an open-source project delivering a simple but feature-rich and +OpenNebula is an open-source project delivering a simple but feature-rich and flexible solution to build and manage enterprise clouds and virtualized data centers. -Complete documentation: http://opennebula.org/documentation:documentation +Complete documentation: https://docs.opennebula.org -How to contribute: http://opennebula.org/community:contribute +How to contribute: https://opennebula.org/community/contribute ## Installation @@ -17,7 +17,7 @@ How to contribute: http://opennebula.org/community:contribute This machine will act as the OpenNebula server and therefore needs to have installed the following software: -* **ruby** >= 1.8.5 +* **ruby** >= 1.8.7 * **sqlite3** >= 3.5.2 * **xmlrpc-c** >= 1.06 * **openssl** >= 0.9 @@ -41,7 +41,7 @@ include a handy script to install them and the requirements. It is located at `share/install_gems/install_gems` and you should use it to install the required gems. You have more information at: - http://opennebula.org/documentation:documentation:compile + https://docs.opennebula.org/5.4/integration/references/compile.html If you want to install them manually here are the list of required rubygems: @@ -59,13 +59,6 @@ If you want to install them manually here are the list of required rubygems: * curb * nokogiri -* OpenNebula zones (client and server) - * json - * sequel - * sqlite3 - * mysql - * nokogiri - * Sunstone server * json * rack @@ -94,24 +87,22 @@ Then install the following packages: install expat libraries with its development files and install xmlparser using gem: - $ sudo gem install xmlparser --no-ri --no-rdoc + $ sudo gem install xmlparser --no-ri --no-rdoc Note the extra parameters to gem install. Some versions of xmlparser have problems building the documentation and we can use it without documentation installed. -* **ruby nokogiri**, to install this gem you will need **libxml2** and - **libxslt** libraries and their development versions. The we can install - nokogiri library: +* **ruby ox**, fast xml parsing library: - $ sudo gem install nokogiri --no-ri --no-rdoc + $ sudo gem install ox --no-ri --no-rdoc ### Building Compilation is done using **scons** command: - $ scons [OPTION=VALUE] + $ scons [OPTION=VALUE] The argument expression *[OPTIONAL]* is used to set non-default values for: @@ -121,7 +112,9 @@ The argument expression *[OPTIONAL]* is used to set non-default values for: mysql yes if you want to build mysql support xmlrpc path-to-xmlrpc-install parsers yes if you want to rebuild flex/bison files - + new_xmlpc yes if you have an xmlrpc-c version >= 1.31 + sunstone yes if you want to build sunstone minified files + ### Installation @@ -129,7 +122,7 @@ OpenNebula can be installed in two modes: system-wide, or in self-contained directory. In either case, you do not need to run OpenNebula as root. These options can be specified when running the install script: - $ ./install.sh install_options + $ ./install.sh install_options where **install_options** can be one or more of: @@ -146,22 +139,30 @@ where **install_options** can be one or more of: client files -r remove Opennebula, only useful if -d was not specified, otherwise rm -rf $ONE_LOCATION would do the job + -p do not install OpenNebula Sunstone non-minified files -h prints installer help -## Configuration +## Deployment -Information on how to configure OpenNebula is located at -http://opennebula.org/documentation:documentation:cg +You can find the documentation about OpenNebula architecture, installation, +configuration and references to configuration files in this documentation +chapter: + +https://docs.opennebula.org/5.4/deployment/index.html + +The reference about the main configuration file is located here: + +https://docs.opennebula.org/5.4/deployment/references/oned_conf.html ## Contact -OpenNebula web page: http://opennebula.org +OpenNebula web page: https://opennebula.org -Development and issue tracking: http://dev.opennebula.org +Development and issue tracking: https://dev.opennebula.org -Support: http://opennebula.org/support:support +Support: https://opennebula.org/support ## License