File

INSTALL @ 12642:9061f9621330

Switch to a new role-based authorization framework, removing is_admin() We began moving away from simple "is this user an admin?" permission checks before 0.12, with the introduction of mod_authz_internal and the ability to dynamically change the roles of individual users. The approach in 0.12 still had various limitations however, and apart from the introduction of roles other than "admin" and the ability to pull that info from storage, not much actually changed. This new framework shakes things up a lot, though aims to maintain the same functionality and behaviour on the surface for a default Prosody configuration. That is, if you don't take advantage of any of the new features, you shouldn't notice any change. The biggest change visible to developers is that usermanager.is_admin() (and the auth provider is_admin() method) have been removed. Gone. Completely. Permission checks should now be performed using a new module API method: module:may(action_name, context) This method accepts an action name, followed by either a JID (string) or (preferably) a table containing 'origin'/'session' and 'stanza' fields (e.g. the standard object passed to most events). It will return true if the action should be permitted, or false/nil otherwise. Modules should no longer perform permission checks based on the role name. E.g. a lot of code previously checked if the user's role was prosody:admin before permitting some action. Since many roles might now exist with similar permissions, and the permissions of prosody:admin may be redefined dynamically, it is no longer suitable to use this method for permission checks. Use module:may(). If you start an action name with ':' (recommended) then the current module's name will automatically be used as a prefix. To define a new permission, use the new module API: module:default_permission(role_name, action_name) module:default_permissions(role_name, { action_name[, action_name...] }) This grants the specified role permission to execute the named action(s) by default. This may be overridden via other mechanisms external to your module. The built-in roles that developers should use are: - prosody:user (normal user) - prosody:admin (host admin) - prosody:operator (global admin) The new prosody:operator role is intended for server-wide actions (such as shutting down Prosody). Finally, all usage of is_admin() in modules has been fixed by this commit. Some of these changes were trickier than others, but no change is expected to break existing deployments. EXCEPT: mod_auth_ldap no longer supports the ldap_admin_filter option. It's very possible nobody is using this, but if someone is then we can later update it to pull roles from LDAP somehow.
author Matthew Wild <mwild1@gmail.com>
date Wed, 15 Jun 2022 12:15:01 +0100 (2022-06-15)
parent 12286:ad88732eea51
line wrap: on
line source
(This file was created from
https://prosody.im/doc/installing_from_source on 2013-03-31)

# Installing from source

## Dependencies

There are a couple of development packages which Prosody needs installed
before you can build it. These are:

-   The [Lua](http://lua.org/) library, version 5.4 recommended
-   [OpenSSL](http://openssl.org/)
-   String processing library, one of
    -   [ICU](https://icu.unicode.org/) (recommended)
    -   [GNU libidn](http://www.gnu.org/software/libidn/)

These can be installed on Debian/Ubuntu by running
`apt build-dep prosody` or by installing the packages
`liblua5.4-dev`, `libicu-dev` and `libssl-dev`.

On Mandriva try:

	urpmi lua liblua-devel libidn-devel libopenssl-devel

On Mac OS X, if you have MacPorts installed, you can try:

	sudo port install lua lua-luasocket lua-luasec lua-luaexpat

On other systems... good luck, but please let us know of the best way of
getting the dependencies for your system and we can add it here.

## configure

The first step of building is to run the configure script. This creates
a file called 'config.unix' which is used by the next step to control
aspects of the build process.

	./configure

All options to configure can be seen by running

	./configure --help

## make

Once you have run configure successfully, then you can simply run:

   make

Simple? :-)

If you do happen to have problems at this stage, it is most likely due
to the build process not finding the dependencies. Ensure you have them
installed, and in the standard library paths for your system.

For more help, just ask ;-)

==== install ====

At this stage you should be able to run Prosody simply with:

   ./prosody

There is no problem with this, it is actually the easiest way to do
development, as it doesn't spread parts around your system, and you
can keep multiple versions around in their own directories without
conflict.

Should you wish to install it system-wide however, simply run:

   sudo make install

...it will install into /usr/local/ by default. To change this you can
pass to the initial ./configure using the 'prefix' option, or edit
config.unix directly. If the new path doesn't require root permission to
write to, you also won't need (or want) to use 'sudo' in front of the
'make install'.

Have fun, and see you on Jabber!