view release on metacpan or  search on metacpan

t/data/generate/wallet/output/readme-md  view on Meta::CPAN

and either `kvno` or `kgetcred` be installed and available on the user's
path.  The test suite will also need to be able to bind to 127.0.0.1 on
ports 11119 and 14373 to test client/server network interactions.

The test suite uses a SQLite database for server-side and end-to-end
testing and therefore requires the DBD::SQLite and
DateTime::Format::SQLite Perl modules.

All of the requirements listed above will be required to run the full test
suite of server functionality, but tests will be selectively skipped if
their requirements aren't found.

The following additional Perl modules will be used if present:

* Test::MinimumVersion
* Test::Pod
* Test::Spelling
* Test::Strict

All are available on CPAN.  Those tests will be skipped if the modules are
not available.

To enable tests that don't detect functionality problems but are used to
sanity-check the release, set the environment variable `RELEASE_TESTING`
to a true value.  To enable tests that may be sensitive to the local
environment or that produce a lot of false positives without uncovering
many problems, set the environment variable `AUTHOR_TESTING` to a true
value.

## Configuration

Before setting up the wallet server, review the Wallet::Config
documentation (with man Wallet::Config or perldoc Wallet::Config).  There
are many customization options, some of which must be set.  You may also
need to create a Kerberos keytab for the keytab object backend and give it
appropriate ACLs, and set up `keytab-backend` and its `remctld`
configuration on your KDC if you want unchanging flag support.

For the basic setup and configuration of the wallet server, see the file
`docs/setup` in the source distribution.  You will need to set up a
database on the server (unless you're using SQLite), initialize the
database, install `remctld` and the wallet Perl modules, and set up
`remctld` to run the `wallet-backend` program.

The wallet client supports reading configuration settings from the system
`krb5.conf` file.  For more information, see the CONFIGURATION section of
the wallet client man page (`man wallet`).

## Support

The [wallet web page](https://www.eyrie.org/~eagle/software/wallet/) will
always have the current version of this package, the current
documentation, and pointers to any additional resources.

New wallet releases are announced on the kerberos mailing list.  To
subscribe or see the list archives, go to the [kerberos list information
page](https://mailman.mit.edu/mailman/listinfo/kerberos).

For bug tracking, use the [issue tracker on
GitHub](https://github.com/rra/wallet/issues).  Please be aware that I
tend to be extremely busy and work projects often take priority.  I'll
save your report and get to it as soon as I can, but it may take me a
couple of months.

## Source Repository

wallet is maintained using Git.  You can access the current source on
[GitHub](https://github.com/rra/wallet) or by cloning the repository at:

https://git.eyrie.org/git/kerberos/wallet.git

or [view the repository on the
web](https://git.eyrie.org/?p=kerberos/wallet.git).

The eyrie.org repository is the canonical one, maintained by the author,
but using GitHub is probably more convenient for most purposes.  Pull
requests are gratefully reviewed and normally accepted.

## License

The wallet package as a whole is covered by the following copyright
statement and license:

> Copyright 2014, 2016, 2018
>     Russ Allbery <eagle@eyrie.org>
>
> Copyright 2006-2010, 2012-2014
>     The Board of Trustees of the Leland Stanford Junior University
>
> Permission is hereby granted, free of charge, to any person obtaining a
> copy of this software and associated documentation files (the "Software"),
> to deal in the Software without restriction, including without limitation
> the rights to use, copy, modify, merge, publish, distribute, sublicense,
> and/or sell copies of the Software, and to permit persons to whom the
> Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in
> all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> DEALINGS IN THE SOFTWARE.

Some files in this distribution are individually released under different
licenses, all of which are compatible with the above general package
license but which may require preservation of additional notices.  All
required notices, and detailed information about the licensing of each
file, are recorded in the LICENSE file.

Files covered by a license with an assigned SPDX License Identifier
include SPDX-License-Identifier tags to enable automated processing of
license information.  See https://spdx.org/licenses/ for more information.

For any copyright range specified by files in this package as YYYY-ZZZZ,
the range specifies every single year in that closed interval.