Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Commit

Permalink
docs: documented the signup configurable option
Browse files Browse the repository at this point in the history
Fixes #179
Fixes #283

Signed-off-by: Miquel Sabaté Solà <[email protected]>
  • Loading branch information
mssola committed Nov 23, 2015
1 parent b34c990 commit 9f1f4f2
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 0 deletions.
16 changes: 16 additions & 0 deletions _docs/Configuring-Portus.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,22 @@ When Portus has been installed via RPM, this operation can be performed via

$ portusctl make_admin <username>

### Disabling the sign up form

By default Portus will have the sign up form available for any person that comes
across your Portus instance. You can change that by disabling the `signup`
configuration value:

{% highlight yaml %}
signup:
enabled: false
{% endhighlight %}

This way, only the admins of this Portus instance will be able to create users
in the system. This setting is completely ignored when LDAP support is enabled.
This option is explained with more detail
[here](/features/disabling_signup.html).

### Enforce SSL usage on production

By default Portus will enforce usage of SSL when ran with the "production"
Expand Down
49 changes: 49 additions & 0 deletions _features/disabling_signup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: post
title: Disabling the sign up form
longtitle: Disable the possibility of users signing up on their own
---

## Disabling the sign up form

You can disable the sign up form in Portus' configuration as explained
[here](/docs/Configuring-Portus.html#disabling-the-sign-up-form).
Since anonymous users will no longer be able to access the signup form, then it
will be up to administrators of the Portus instance to sign up new users into
the system. An admin user can do this in two ways: through a form provided in
the admin section, or with a simple rake task.

### The form on the admin section

Just access the admin section and click on the `Users` container. By doing so,
you will access to the users section, and it should be similar to this:

![Users](/build/images/docs/users-panel.png)

As you can see in the image above, in the top right corner of the users list
there is a link for creating a new user. Click it and you will access the
following form:

![Create user](/build/images/docs/new-user-form.png)

### The rake task

If you have access to the server directly, you can call the following rake
task:

$ rake portus:create_user[username,[email protected],password,false]

If you have installed Portus from the [RPM](/docs/setups/1_rpm_packages.html),
you can also use `portusctl` for that:

$ portusctl rake portus:create_user[username,[email protected],password,false]

Note that if you have installed Portus from the RPMs, it's better to use
`portusctl`, since it will always pick the right gems.

## The password for created users

Portus is flexible enough so you don't have to overcomplicate the process of
creating new users. In this case, you can setup whatever password you wish for
the created users, and then tell said users to immediately change their
passwords by accessing their profile pages.
Binary file added assets/images/docs/new-user-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/docs/users-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9f1f4f2

Please sign in to comment.