Skip to content

Commit a566f06

Browse files
committed
Docs improvements around safer defaults content
1 parent afc84f6 commit a566f06

File tree

2 files changed

+44
-51
lines changed

2 files changed

+44
-51
lines changed

docs/roller-install-guide.adoc

Lines changed: 40 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -35,53 +35,46 @@ of the Apache Software Foundation.
3535

3636
== Securing Roller
3737

38-
Security should be top-of-mind when setting up any web site, even one
39-
that is on a private network and internal to your organization. Here are
40-
some recommendations for keeping your Roller installation secure:
41-
42-
* *Perform Roller installation on a secure network*. When you are
43-
installing Roller it is possible for other users to interfere with your
44-
installation. If other users have access to the server, one of them
45-
could attempt to access the Roller database or files while you are
46-
installing Roller. To prevent this, install Roller on a secure network
47-
or at a time when other users are not using the server.
48-
49-
* *Do not allow new user registrations*. By default, Roller allows new
50-
users to register themselves. This is convenient, but it also means that
51-
anyone can create an account on your Roller site. If you do not want
52-
this, go to the Server Administration page and disable the *Allow New
53-
Users* option.
54-
55-
* *Sanitize all HTML*. By default, Roller sanitizes all HTML published by the system to ensure that user posts are safe and free from malicious content. This is controlled by the _weblogAdminsUntrusted=true_ property in your _roller-custom.properties_ file.
56-
57-
* *Do not allow custom themes*. By default, Roller does not allow users to
58-
create custom themes. You can enable this via the Server Admin page, but
59-
don't do it unless you trust your users because it can allow users to
60-
create custom themes that can be used to compromise your site.
61-
62-
* *Do not allow File Uploads*. By default, Roller does not allow users to upload
63-
files for display on their blogs. If you trust your users, then you can enable
64-
file uploads via the Server Admin page.
65-
66-
* *Do not allow HTML in comments*. By default, Roller does not allow users to write
67-
comments in HTML due to security concerns. This setting helps prevent potential
68-
security issues related to HTML content in comments.
69-
70-
By following these recommendations, you can help ensure that your Roller
71-
installation remains secure and protected from common web vulnerabilities.
72-
73-
* *Run Roller over SSL connection*. If you run Roller over a plain old
74-
HTTP connection, it is possible for others to snoop your password when
75-
you login, for example over an open WIFI network. To configure Roller to
76-
work over SSL (i.e., using https:// URLs), first modify the web.xml
77-
located in the Roller WAR (WEB-INF folder), uncommenting the
78-
<security-constraint/> element and following the instructions given in
79-
that file above that element. Next, follow your servlet container’s
80-
documentation for setting up SSL
81-
(http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html for Tomcat, for
82-
example.) Then redeploy Roller and confirm that pages containing secure
83-
data such as the login page and new user registration page are available
84-
only via https:// URLs.
38+
Security is crucial when setting up any website, even on a private network.
39+
Here are some recommendations to keep your Roller installation secure:
40+
41+
* *Install Roller on a secure network*. During installation, other users could
42+
interfere or access the Roller database or files. To prevent this, install Roller
43+
on a secure network or when the server is not in use by others.
44+
45+
* *Disable new user registrations*. By default, Roller allows self-registration,
46+
which means anyone can create an account. To prevent this, disable the
47+
*Allow New Users* option on the Server Administration page.
48+
49+
* *Use SSL for Roller*. Running Roller over HTTP can expose your password
50+
to snooping, especially on open WIFI networks. To configure SSL (https:// URLs),
51+
modify the web.xml in the Roller WAR (WEB-INF folder) by uncommenting
52+
the <security-constraint/> element and following the instructions.
53+
Then, follow your servlet container’s SSL setup documentation
54+
(e.g., http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html for Tomcat).
55+
Redeploy Roller and ensure secure pages like the login and registration
56+
pages are accessible only via https:// URLs.
57+
58+
Following these recommendations will help secure your Roller installation against
59+
common web vulnerabilities.
60+
61+
=== Safer defaults
62+
63+
As of Roller 6.1.4, several default settings have been updated to enhance security
64+
for multi-user weblog sites:
65+
66+
* *HTML content sanitization*: Roller now sanitizes all HTML content by default
67+
to prevent malicious content. This is controlled by the _weblogAdminsUntrusted=true_
68+
property in your _roller-custom.properties_ file.
69+
70+
* *Custom themes disabled*: By default, users cannot create custom themes.
71+
This can be enabled via the Server Admin page if you trust your users, as custom themes can pose security risks.
72+
73+
* *File uploads disabled*: By default, file uploads are not allowed.
74+
If you trust your users, you can enable this feature via the Server Admin page.
75+
76+
NOTE: If you are a solo blogger, you can safely enable un-sanitized HTML,
77+
file uploads, and custom themes by adjusting the above settings.
8578

8679
== Ready to roll?
8780

docs/roller-template-guide.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ Design -> Templates pages and you won’t be able to change or
4141
customize your theme. You need to have ADMIN permission within a weblog
4242
to be able to do the things described in this guide.
4343

44-
NOTE: It is possible for a Roller site administrator to disable theme
45-
customization. So if you do have ADMIN permission in your weblog and you
46-
still don’t see the Design -> Templates page, perhaps your Roller
47-
site does not allow customization.
44+
NOTE: By default, theme customization is disabled in Roller.
45+
If you do have ADMIN permission in your weblog and you don’t see the
46+
Design -> Templates page, perhaps your Roller site does not allow customization.
47+
See your Roller Administrator about enabling custom themes on the Server Admin page.
4848

4949
== The Roller template system
5050

0 commit comments

Comments
 (0)