The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Yukki-0.991_004
River stage zero No dependents
2 ++
/ Yukki::Settings

NAME

Yukki::Settings - provides structure and validation to settings in yukki.conf

VERSION

version 0.991_004

DESCRIPTION

This class provides structure for the main application configuration in Yukki.

Yukki may fail to start unless your configuration is correct.

ATTRIBUTES

root

This is the wiki site directory. This should be the same folder that was given the yukki-setup command. It works best if you make this an absolute path.

repository_path

This is the folder where Yukki will find the git repositories installed under root. The default is root/repositories.

user_path

This is the folder where the list of user files can be found.

digest

This is the name of the digest algorithm to use to store passwords. See Digest for more information. The default is "SHA-512".

N.B. If you change digest algorithms, old passwords saved with the old digest algorithm will continue to work as long as the old digest algorithm class is still installed.

anonymous

This is a section configuring anonymous user information.

author_name

This is the name to use when an anonymous user makes a change to a wiki repository.

author_email

This is the email address to use when an anonymous user makes a change to a wiki repository.

repo_path

This is the folder where repository configuraiton files can be found. This path is intended for application managed repository configuration files. If you want to manage your repositories from the command-line instead, store the repository configurations under the repository key in the main settings file.

repositories

This is a section under which each repository is configured. The keys under here are the name found in the URL. It is also the name to use when running the yukki-git-init and other repository-related commands.

Repository configurations may be stored either in the main Yukki configuration file under the repositories key or as individual files located in the directory named in the repo_path key. If a configuration is named in both places, the one in the main settings file will always be used.

Each repository configuration should provide the following configruation keys.

special_privileges

This section of the settings configures which groups grant special privileges. These special privileges grant access to view or change the configuration from within the application. By default, no one has these privileges, effectively disabling any in-app administrative features.

The grants for each here are identical to that available to repositories:

anonymous_access_level

This names the access level anonymous users have. Obviously, it would generally be unwise for this to be anything but "none" for adminsitrative functions, but "read" and "write" are other possible values.

read_groups

Names the list of groups that are granted permission to perform read-only actions. This may also be set to "ANY" to specify that any logged user may perform this action or "NONE" to specify that no logged user may perform this action.

write_groups

Names the list of groups that are granted permission to perform read-write actions. As with read, this may be set to "ANY" and "NONE" with the same meaning.

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.