Project

Profile

Help

Make Redmine Projects Public on Planio » History » Sprint/Milestone 55

Jan Schulz-Hofen, 03/17/2017 09:37 AM

1 1 Jan Schulz-Hofen
# Make Redmine Projects Public on Planio
2
3 55 Jan Schulz-Hofen
Planio is powered by Redmine and as such it offers the same great possibilities to make Redmine projects public on the Internet. You can choose whether your projects should be accessible to anyone – without the need to login, including search engines – or whether you'd like visitors to sign up first and leave their email address. You can also choose to manually confirm signups or confirm them automatically by sending an activation link in an email.
4 1 Jan Schulz-Hofen
5
{{>toc}}
6
7 16 Jan Schulz-Hofen
## What are Public Projects used for?
8
9 19 Jan Schulz-Hofen
Making your projects public is a great way to provide a **help desk for your customers**. Allow them to view FAQs or tutorial guides in the wiki ([like we do at Planio](https://support.plan.io/projects/planio-support-en)) or let them sign up to discuss in forums or create issues.
10 17 Jan Schulz-Hofen
11 19 Jan Schulz-Hofen
Public projects in Planio are also great for collaboration on **Open Source projects**, for instance. You could also use it to host **public [Git or Subversion](https://plan.io/subversion-hosting-and-git-hosting/) Repositories**.
12 13 Jan Schulz-Hofen
13 1 Jan Schulz-Hofen
Sounds fun? Follow this guide to learn how it's done.
14
15 24 Jan Schulz-Hofen
## How to Make a Project Public?
16 1 Jan Schulz-Hofen
17 4 Jan Schulz-Hofen
A public project on on your Planio powered Redmine account is essentially that: **An open project that is available to the public**.
18
19 22 Jan Schulz-Hofen
Normally, only the explicitly named members of a project in Planio can access it and outsiders cannot see what's going on.
20
21
Let's change that! Here's how:
22 4 Jan Schulz-Hofen
23
1.  Find your project or create a new one
24
2.  Navigating to **Settings** -\> **Information** in your project
25
3.  Check the box next to the **Public** label and click **Save**
26
27 5 Jan Schulz-Hofen
{{figure(Make Projects Public on Redmine by Planio)
28
!make_redmine_project_public@2x.png!
29
}}
30
31 4 Jan Schulz-Hofen
Congratulations! You now have a public project.
32
33 6 Jan Schulz-Hofen
### Optional: Make all Projects Public by Default
34 4 Jan Schulz-Hofen
35
Would you like to make all projects public by default? No problem:
36
37
1.  Navigate to *your avatar* -\> **Administration** -\> **Settings** -\> **Projects**
38
2.  Check **New projects are public by default**
39
3.  Click **Save**
40
41 25 Jan Schulz-Hofen
### Optional: Allow Anonymous Access From the Web
42 23 Jan Schulz-Hofen
43
Public projects are open to all users in your Planio account. But you can take this a step further and allow access to people who have not even logged in. This will public your public projects on the Web, making your content accessible to anyone and also allow search engines to index it.
44
45
Here's how:
46
47
1.  Navigate to *your avatar* -\> **Administration** -\> **Settings** -\> **Authentication**
48
2.  Uncheck **Authentication required**
49
3.  Click **Save**
50
51 28 Jan Schulz-Hofen
{{figure(Uncheck "Authentication required" to allow anyone in)
52 27 Jan Schulz-Hofen
!allow_anonymous_access_from_the_web@2x.png!
53
}}
54
55 23 Jan Schulz-Hofen
Be careful though with this option. You should not have any secrets in your public projects now – the whole World will be able to see them!
56
57
Next, we'll learn how exactly these changes impact your projects and who will be able to see and do what exactly.
58 4 Jan Schulz-Hofen
59 21 Jan Schulz-Hofen
## The Non-Member & Anonymous Roles
60 1 Jan Schulz-Hofen
61 8 Jan Schulz-Hofen
Now that you've made your project public, let's see how this changes the access permissions to it.
62
63
Please navigate to *your avatar* -\> **Administration** -\> **Roles and Permissions** for a moment. You'll see two special roles in addition to [your own individual roles](https://plan.io/roles-and-permissions/) which you can define yourself:
64
65 1 Jan Schulz-Hofen
{{figure(Non-Member and Anonymous Roles)
66
!non-member_and_anonymous_roles_in_redmine@2x.png!
67
}}
68 10 Jan Schulz-Hofen
69
### The **Non-Member** Role
70
71
Click on the **Non-Member** role to pull up its permissions. What you configure here will govern what **any user in your Planio account** will be allowed to see and do in your **public projects**.
72
73 12 Jan Schulz-Hofen
Specifically, this means that you won't have to add users to this public project anymore to give them access to it. Any user who does not have a specific role in the project automatically gets the permissions set in the **Non-Member** role. Users who *are members* in a public project will have all permissions from both the **Non-Member** role and their explicit membership roles combined.
74 10 Jan Schulz-Hofen
75 11 Jan Schulz-Hofen
{{figure(Permissions of the Non-Member role)
76
!permissions_of_non-member_role@2x.png!
77
}}
78
79 10 Jan Schulz-Hofen
### The **Anonymous** Role
80 9 Jan Schulz-Hofen
81 29 Jan Schulz-Hofen
The **Anonymous** role is only relevant to you if you unchecked the **Authentication required** checkbox above. Similar to how the **Non-Member** role defines what logged in users can see or do, the **Anonymous** role specifies what anonymous users – who are not even logged in – can see or do.
82
83
We generally recommend to only give **view** permissions to the Anonymous role. Commenting or even creating content should only be done by logged in users.
84
85
We'll learn how to ask users to register for an account in a minute. Read on!
86
87 1 Jan Schulz-Hofen
### Individually Adding Anonymous and Non-Members to Projects
88 7 Jan Schulz-Hofen
89 30 Jan Schulz-Hofen
If using the **Anonymous** and **Non-Member** roles isn't specific enough for your use case and if you would like anonymous users or non-members to have different permissions in different projects, you can also add **Anonymous** and **Non-Member** as if they were real users – using the regular roles.
90
91
Let's take a look:
92
93
1.  Go to your public project
94
2.  Navigate to **Settings** -\> **Members**
95
3.  Click on **New member**
96
97 34 Jan Schulz-Hofen
{{figure(Add non-member users as if they were staff)
98 30 Jan Schulz-Hofen
!individually_adding_anonymous_and_non-members_to_projects@2x.png!
99
}}
100
101 32 Jan Schulz-Hofen
You'll find **Anonymous** and **Non-Member** among the list of regular users and groups. Now, you could add your **Non-Member** role with a role of *Staff* for instance. The result would be that non-members will be able to see and do exactly the same as normal members with a role of *Staff*.
102 30 Jan Schulz-Hofen
103
It's quite advanced, we agree. In most cases it will be sufficient to configure your **Non-Member** and **Anonymous** roles' permissions.
104
105 37 Jan Schulz-Hofen
## User Self-Registration
106 1 Jan Schulz-Hofen
107 38 Jan Schulz-Hofen
Earlier we said that it's recommended to only allow **view** permissions to anonymous users – you most probably don't want to end up receiving spam comments on your Planio and don't even know who posted them!
108 35 Jan Schulz-Hofen
109 39 Jan Schulz-Hofen
In this section, we'll show you how anonymous users can register for an account on your Planio using their email address.
110 35 Jan Schulz-Hofen
111 37 Jan Schulz-Hofen
### Activation Options
112 35 Jan Schulz-Hofen
113 36 Jan Schulz-Hofen
Let's set some settings first. Please navigate to *your avatar* -\> **Administration** -\> **Settings** -\> **Authentication**. You'll be presented with a screen like this:
114 1 Jan Schulz-Hofen
115 36 Jan Schulz-Hofen
{{figure(Defining options for self-registration and activation)
116
!allow_self-registration@2x.png!
117
}}
118 35 Jan Schulz-Hofen
119 40 Jan Schulz-Hofen
Let's take a look at the options for the **Self-registration** setting:
120
121
  - **Account activation by email** will allow anonymous users to sign up using their email address. They will receive an email with an activation link. Once they've clicked it, they will be active users in your Planio account.
122 41 Jan Schulz-Hofen
  - **Manual account activation** will also allow sign ups but instead of sending activation emails, it will notify all administrators in your Planio account and you will have to activate the new users manually before they can login.
123 42 Jan Schulz-Hofen
  - **Automatic account activation** will allow anyone to sign up for a new account. New user accounts will be active immediately without any activation checks via email or by an admin.
124 1 Jan Schulz-Hofen
  - **Disabled** means that new users in your Planio account have to be added by admins – this is the default.
125 41 Jan Schulz-Hofen
126
We recommend to use **account activation by email** or **manual account activation** depending on your personal preference.
127 40 Jan Schulz-Hofen
128 35 Jan Schulz-Hofen
Once registered, your new users won't have project memberships yet, so make sure to configure your **Non-Member** role. For example, you could allow anonymous users to view blog posts and non-member users to comment on them.
129 1 Jan Schulz-Hofen
130
### Conversion Optimization
131 20 Jan Schulz-Hofen
132 43 Jan Schulz-Hofen
Once **self-registration** is enabled on your account, anonymous users will find a menu item called **Registration** within the *avatar menu* on the top right.
133
134
But if you really want to build a community and encourage participation in your Planio account, that may not be enough.
135
136 44 Jan Schulz-Hofen
You might want to check out these two options in *your avatar* -\> **Administration** -\> **Settings** -\> **Authentication**:
137 1 Jan Schulz-Hofen
138 44 Jan Schulz-Hofen
  - **Enable registration call to action** will display registration links to anonymous users in various places where they would be able to participate if they were registered. For example, if non-members are allowed to create new issues, anonymous users will see a link saying **Please register to add an issue** right on the issues list.  
139
    {{figure(Registration CTA for creating issues)
140
!registration_call_to_action_for_creating_issues@2x.png!
141
}}
142 45 Jan Schulz-Hofen
  - **Show custom fields on registration** will – when disabled – hide any extra [custom fields](https://plan.io/customizing/) on the registration form for your Planio account to make sign ups easier on new users by not asking too much information upfront. They can always fill out these fields later after registration.
143 43 Jan Schulz-Hofen
144 46 Jan Schulz-Hofen
## Make Your Public Planio Your Own
145 26 Jan Schulz-Hofen
146 46 Jan Schulz-Hofen
Next up, we'll learn how to customize your user's experience with your Planio account. Here's how to make them feel right at home:
147 1 Jan Schulz-Hofen
148 46 Jan Schulz-Hofen
### Title and Welcome Text
149
150
Please navigate to *your avatar* -\> **Administration** -\> **Settings** -\> **General**. Here, you can set an **Application title** – e.g. company name – and a **Welcome text**. Welcome texts allow for regular wiki markup, so you can use formatting options and even embed your company logo.
151
152
Below you'll see a customized welcome page as it's shown to anonymous users:
153
154
{{figure(Welcome page for anonymous users)
155
!welcome_page_for_anonymous_users@2x.png!
156
}}
157
158 1 Jan Schulz-Hofen
### Blog posts
159
160 46 Jan Schulz-Hofen
You can also write blog posts within your public Planio projects and assign the **View blog** permission to your **Anonymous** role. They will be shown on your public Planio account and users will even be able to subscribe to them using their feed readers.
161
162
### Paid extras: Your own Design and Domain
163
164
If you'd like to take things even further, you can get your Planio account re-designed using your own logo and colors and we also offer the possibility to run your Planio account on your own Internet domain.
165
166 48 Jan Schulz-Hofen
Both extras are included for free within our [Enterprise plan](https://plan.io/pricing/#enterprise) and are available for 15 Euro\* per month each (+ 100 Euro\* setup for the design) in all other plans. [Get in touch with us](https://plan.io/contact/#subject=Request%20for%20custom%20design%20and%20domain&description=Hello%20Planio%2C%0D%0A%0D%0AI%20would%20like%20to%20use%20a%20custom%20domain%20for%20my%20account.%20Please%20prepare%20a%20custom%20design%20based%20on%20our%20homepage%2C%20too.%0D%0A%0D%0AI%27d%20like%20to%20use%20the%20domain%3A%20...%0D%0AOur%20existing%20homepage%20is%20at%3A%20...%0D%0A%0D%0AAdditionally%2C%20we%20need...%0D%0A%0D%0AThanks%21%0D%0A%0D%0A%0D%0A) to activate these extras for your account.
167 46 Jan Schulz-Hofen
168
\*) Prices are subject to VAT depending on where you are based.
169 26 Jan Schulz-Hofen
170 20 Jan Schulz-Hofen
## Popular examples
171
172 49 Jan Schulz-Hofen
Need some examples? Here are some Planio accounts that use public projects:
173
174 50 Jan Schulz-Hofen
  - [**Saxonica**](https://saxonica.plan.io/) – Development for the [Saxon](http://saxonica.com/) processor for XSLT, XQuery, and XML Schema
175 51 Jan Schulz-Hofen
  - [**Pulp**](https://pulp.plan.io/) – A software package managing platform called [Pulp](http://pulpproject.org/), run by Red Hat
176 54 Jan Schulz-Hofen
  - [**Open Source and Linux Lab**](https://osll.plan.io/) – A community of computer scientists and software developers called [OSLL](https://osllblog.wordpress.com/)
177 49 Jan Schulz-Hofen
178 51 Jan Schulz-Hofen
Want to add your Planio account to the list? [Get in touch](https://plan.io/contact/#subject=Please%20add%20my%20public%20Planio%20account%20to%20your%20list&description=Hello%20Planio%2C%0D%0A%0D%0AI%20am%20using%20Planio%20for%20public%20projects%20that%20are%20accessible%20on%20the%20Web.%20Can%20you%20add%20my%20account%20to%20your%20list%3F%0D%0A%0D%0AThanks%21%0D%0A%0D%0A%0D%0A) and we'll list it here!