---
name: "Perlanet::Trait::YAMLConfig"
section: "3pm"
platform: "linux"
package: "libperlanet-perl"
version: "2.2.1-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Perlanet::Trait::YAMLConfig"
---

# Perlanet::Trait::YAMLConfig(3pm)

configure Perlanet through a YAML configuration file

## NAME

Perlanet::Trait::YAMLConfig - configure Perlanet through a YAML configuration file

## SYNOPSIS

```
   package MyPerlanet;
   extends 'Perlanet';
   with 'Perlanet::Traits::YAMLConfig';
   my $perlanet = MyPerlanet->new_with_config(
     configfile => 'whatever.yml'
   );
   $perlanet->run;
```

## DESCRIPTION

Allows you to move the configuration of Perlanet to an external YAML configuration file.

### Example Configuration File

```
  title: planet test
  description: A Test Planet
  url: http://planet.example.com/
  author:
    name: Dave Cross
    email: dave@dave.org.uk
  entries: 20
  opml: opml.xml
  page:
    file: index.html
    template: index.tt
  feed:
    file: atom.xml
    format: Atom
  cache_dir: /tmp/feeds
  feeds:
    - url: http://blog.dave.org.uk/atom.xml
      title: Dave's Blog
      web: http://blog.dave.org.uk/
    - url: http://use.perl.org/~davorg/journal/rss
      title: Dave's use.perl Journal
      web: http://use.perl.org/~davorg/journal/
    - url: http://www.oreillynet.com/pub/feed/31?au=2607
      title: Dave on O'Reillynet
      web: http://www.oreillynet.com/pub/au/2607
```

## METHODS

### get\_config\_from\_file

Extracts the configuration from a YAML file

### read\_config

Actually reads the YAML.

## AUTHOR

Oliver Charles, \<oliver.g.charles@googlemail.com\>

## COPYRIGHT AND LICENSE

Copyright (c) 2010 by Magnum Solutions Ltd.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.