Skip to content

Commit b29a7d8

Browse files
committed
Updated INSTALL.md.
1 parent ee69ea1 commit b29a7d8

File tree

1 file changed

+40
-33
lines changed

1 file changed

+40
-33
lines changed

INSTALL.md

+40-33
Original file line numberDiff line numberDiff line change
@@ -8,79 +8,86 @@ This guide provides step by step information on how to install OpenCms using Tom
88
- [Download and deploy the opencms.war file](#download-and-deploy-the-opencms-war-file)
99
- [Follow the setup wizard](#follow-the-setup-wizard)
1010
- [Login to the OpenCms workplace](#login-to-the-opencms-workplace)
11-
- [Deploying on a production environment](#deploying-on-a-production-environment)
11+
- [Security settings](#security-settings)
1212

1313
## Install Java
1414

15+
OpenCms supports Java 8 and Java 11 LTS.
16+
1517
Download and install Java, e.g., from one of the following repositories:
1618

1719
* [OpenJDK](https://openjdk.java.net/projects/jdk/)
1820
* [Oracle](https://www.oracle.com/java/technologies/downloads/)
1921

20-
OpenCms 13 is tested with Java 8 and Java 11.
21-
22-
You must install a Java JDK (Java Development Kit), a JRE (Java Runtime Environment) is not sufficient.
23-
22+
You must install a Java JDK (Java Development Kit), not a JRE (Java Runtime Environment).
2423
Make sure that the `JAVA_HOME` environment variable points to your installed Java SDK and Java is working properly.
2524

2625
## Install Tomcat
2726

28-
Download and install Tomcat from [https://tomcat.apache.org/](https://tomcat.apache.org/) into a folder of your choice.
27+
OpenCms supports Tomcat 9.x and 8.x.
2928

29+
Download and install Tomcat from [https://tomcat.apache.org/](https://tomcat.apache.org/) into a folder of your choice.
3030
OpenCms requires a Servlet 3.1 / JSP 2.3 standards compliant container.
31-
32-
OpenCms 13 is tested with Tomcat 9 and 8.5.
33-
3431
Make sure that the environment variable `CATALINA_HOME` points to the folder where you did install Tomcat.
3532

36-
Start Tomcat and make sure it is running properly.
33+
OpenCms integrates image processing tools that rely on Java AWT. In most Linux distributions Java AWT is available by default.
34+
If you run a purely headless Linux system, image processing will not work and Tomcat has to be started with the additional command line argument `-Djava.awt.headless=true`.
3735

38-
**Please note**: OpenCms integrates image processing tools that rely on Java AWT. In most Linux distributions Java AWT is available by default. If you run a purely headless Linux system, image processing will not work and Tomcat has to be started with the additional command line argument `-Djava.awt.headless=true`.
36+
Start Tomcat and make sure it is running properly.
3937

4038
## Install MariaDB/MySQL
4139

42-
Download and install MariaDB from [https://mariadb.org/download/](https://mariadb.org/download/) or MySQL from [https://dev.mysql.com/downloads/mysql/](https://dev.mysql.com/downloads/mysql/).
43-
44-
OpenCms can be used with MariaDB/MySQL >= 5.5.
45-
46-
**Important**: There is one special database setting needed to run OpenCms, the database setting `max_allowed_packet`. You find the `max_allowed_packet` setting in the database configuration file, usually `my.cnf` on Unix systems or `my.ini` on Windows. Since OpenCms stores binary files such as images or PDF documents in the database, the limit should be as high as the largest binary file. At least `max_allowed_packet=32M` is recommended.
40+
OpenCms supports MariaDB/MySQL 5.5 and later.
4741

48-
Start the MariaDB/MySQL database and make sure it is running properly.
42+
Download and install MariaDB from [https://mariadb.org/download/](https://mariadb.org/download/) or MySQL from [https://dev.mysql.com/downloads/mysql/](https://dev.mysql.com/downloads/mysql/).
4943

44+
Before running OpenCms you **must** update the datbase setting `max_allowed_packet` to `max_allowed_packet=32M` (or more).
45+
You find this setting in the database configuration file, usually `my.cnf` on Unix systems or `my.ini` on Windows.
46+
This is required since OpenCms stores binary files such as images or PDF documents in the database.
5047
More information about database settings is available [here](https://documentation.opencms.org/opencms-documentation/server-installation/).
5148

52-
## Download and deploy the opencms.war file
53-
54-
Download the latest OpenCms distribution here: [http://www.opencms.org/en/download/opencms.html](http://www.opencms.org/en/download/opencms.html).
49+
Start the database and make sure it is running properly.
5550

56-
Extract the distribution ZIP file.
51+
## Download and deploy OpenCms
5752

58-
Copy the opencms.war file from the distribution ZIP file to `{CATALINA_HOME}/webapps/`. Replace `{CATALINA_HOME}` with the real path of your Tomcat installation.
53+
Download the latest OpenCms distribution from [http://www.opencms.org/en/download/opencms.html](http://www.opencms.org/en/download/opencms.html).
54+
Unpack the distribution ZIP file.
55+
Copy the opencms.war file from the distribution to `{CATALINA_HOME}/webapps/` (replace `{CATALINA_HOME}` with the path of your Tomcat installation).
5956

60-
Restart Tomcat. Tomcat will now deploy the web application OpenCms.
57+
Restart Tomcat.
58+
Tomcat should now deploy OpenCms as a web application.
6159

62-
**Important**: OpenCms requires that its `*.war` file is unpacked, otherwise OpenCms can not be deployed. Make sure Tomcat does unpack the war file and creates the `CATALINA_HOME/webapps/opencms/` directory, placing the OpenCms files in this directory. The default configuration for your Servlet container could be to not unpack the deployed `*.war` file. If this is the case, you must unpack the `opencms.war` file manually.
60+
OpenCms requires that its `*.war` file is unpacked, otherwise OpenCms will not be deployed correctly.
61+
Make sure Tomcat does unpack the war file and creates the `{CATALINA_HOME}/webapps/opencms/` directory, with the OpenCms files in this directory.
62+
The default configuration for your Servlet container may be to not unpack the deployed `*.war` file.
63+
If this is the case, you must unpack the `opencms.war` file manually.
6364

6465
## Follow the setup wizard
6566

6667
Start the setup wizard by pointing your browser to `http://localhost:8080/opencms/setup/`.
67-
68-
Follow the instructions of the OpenCms setup wizard. For normal installations with MariaDB/MySQL and Tomcat running on the same server, all default settings will be fine. If you are using special database users, be sure that they exist before.
68+
Follow the instructions of the OpenCms setup wizard.
69+
For normal installations with MariaDB/MySQL and Tomcat running on the same server, all default settings will be fine.
6970

7071
A detailed explanation of the various setup wizard options is available in the [getting started guide](https://documentation.opencms.org/opencms-documentation/introduction/getting-started/).
7172

7273
## Login to the OpenCms workplace
7374

74-
Now your system is ready to use. You can login with username `Admin` and password `admin`.
75+
Your OpenCms installation is now ready to use.
76+
77+
The login URL of the OpenCms workplace in a default configuration is: `http://localhost:8080/opencms/system/login/`.
78+
You can login with username `Admin` and password `admin`.
7579

76-
The login URL of OpenCms in a default configuration is: `http://localhost:8080/opencms/system/login/`.
80+
Make sure you disable all pop-up blockers and enable Javascript for your OpenCms server URL.
81+
Otherwise you may not be able to log in.
7782

78-
Make sure you disable all pop-up blockers and enable Javascript for the server URL you installed OpenCms. Otherwise you will not be able to log in.
83+
## Security settings
7984

80-
## Deploying on a production environment
85+
After your OpenCms is running you definitely should change the default passwords!
8186

82-
Do not forget to change the password of the `Admin` user on a production environment.
87+
To change the `Admin` user password of OpenCms, first login to the OpenCms workplace using the default password `admin`.
88+
Then click on the user icon on the top right, and select *Change password* in the drop down menu.
8389

84-
To do so, login to the OpenCms workplace, click on the user icon on the top right, and follow the <em>Change password</em> menu item shown in the drop down menu.
90+
You should also add a password for the OpenCms database connection.
91+
Please consult the documentation of your database for information about how to do so.
8592

86-
There is [additional documentation](https://documentation.opencms.org/opencms-documentation/server-installation/) available on deploying OpenCms in a production environment.
93+
There is [additional documentation](https://documentation.opencms.org/opencms-documentation/server-installation/) available on deploying OpenCms in a production environment.

0 commit comments

Comments
 (0)