NAME

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

VERSION

version 0.140290

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.

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.

Each repository configuraiton should provide the following configruation keys.

repository

This is required. This is the name of the git repository folder found under repository_path.

site_branch

This is teh name of the branch that will contain the wiki's files. The default is refs/heads/master. You could actually use the same git repository for multiple Yukki repositories by using different branches. If you want to do it that way for some reason. Unless you know what you're doing, you probably don't want to do that.

name

This is a human readable title for the repository.

default_page

This is the name of the main repository index.

anonymous_access_level

This should be set to one of the following: read, write, or none. This settings decides how much access an anonymous user has when visiting your wiki.

read_groups

This may be set to the word "ANY" or the word "NONE" or to an array of group names.

If set to ANY, any logged user may read this repository. If set to NONE, read access is not granted to any logged user (though if anonymous_access_level or write_groups grant a user access, the user will be able to read the repository).

If an array of one or more group names are given, the users with any of those groups will be able to read the repository.

write_groups

THe possible values that may be set are identicl to read_groups. This setting determines who has permission to edit pages and upload files to the repository.

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 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.