GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  UBIC::SETTINGS (3)

.ds Aq ’

NAME

Ubic::Settings - ubic settings

CONTENTS

VERSION

version 1.58

SYNOPSIS



    my $service_dir = Ubic::Settings->service_dir;
    my $data_dir = Ubic::Settings->data_dir;
    my $default_user = Ubic::Settings->default_user;

    Ubic::Settings->data_dir($new_dir);



DESCRIPTION

This module can be used to get common ubic settings: service_dir, data_dir and default_user.

Note that these settings are global and used by ubic core. Services don’t have to use data_dir to store their data, for example; they can use any dir they want.

Settings are determined in the following order (from the most priority to the least):
o Overrides via data_dir(), service_dir() and default_user() methods.
o Environment variables UBIC_SERVICE_DIR, UBIC_DIR and UBIC_DEFAULT_USER (which affect accordingly service_dir, data_dir and default_user);
o Config file at ~/.ubic.cfg, /etc/ubic/ubic.cfg or /usr/local/etc/ubic/ubic.cfg, in this order;
o If none of these settings are set, it will fail and advice to run ubic-admin setup.

METHODS

If any of setting methods is called with new value, this value will be applied for current process only.

They also will be propagated to future child processes via environment variables.
<B>B>service_dir()<B>B>
<B>service_dir($dir)B> Get or set directory with service descriptions.
<B>B>data_dir()<B>B>
<B>data_dir($dir)B> Get or set directory into which ubic stores all of its data (locks, status files, tmp files).
<B>B>default_user()<B>B>
<B>default_user($user)B> Get or set user for services which don’t specify user themselves.
<B>B>check_settings()<B>B> Check if all settings are valid.

Will throw an exception if any configuration options are not set.

AUTHOR

Vyacheslav Matyukhin <mmcleric@yandex-team.ru>

COPYRIGHT AND LICENSE

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 UBIC::SETTINGS (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.