/mandos/trunk : revision 769

To get this branch, use:

bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.xml

Committer: Teddy Hogeborn
Date: 2015-07-12 01:41:14 UTC
Revision ID: teddy@recompile.se-20150712014114-qbala4mutkixxct3

Handle local Zeroconf service name collisions on startup, too.

* mandos (AvahiService.server_state_changed): Catch name collision
error when adding
server.

Show diffs side-by-side

added added

removed removed

plugin-runner.xml

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY COMMANDNAME "plugin-runner">

<!ENTITY TIMESTAMP "2012-01-01">

<!ENTITY TIMESTAMP "2015-06-28">

<!ENTITY % common SYSTEM "common.ent">

%common;

114

<arg><option>--plugin-dir=<replaceable

115

>DIRECTORY</replaceable></option></arg>

116

<sbr/>

117

<arg><option>--plugin-helper-dir=<replaceable

118

>DIRECTORY</replaceable></option></arg>

119

<sbr/>

117

120

<arg><option>--config-file=<replaceable

118

121

>FILE</replaceable></option></arg>

119

122

<sbr/>

320

323

</varlistentry>

321

324

322

325

326

<term><option>--plugin-helper-dir

327

<replaceable>DIRECTORY</replaceable></option></term>

328

329

<para>

330

Specify a different plugin helper directory. The default

331

is <filename>/lib/mandos/plugin-helpers</filename>, which

332

will exist in the initial <acronym>RAM</acronym> disk

333

environment. (This will simply be passed to all plugins

334

via the <envar>MANDOSPLUGINHELPERDIR</envar> environment

335

variable. See <xref linkend="writing_plugins"/>)

336

</para>

337

</listitem>

338

</varlistentry>

339

340

323

341

<term><option>--config-file

324

342

325

343

426

444

<para>

427

445

The plugin will run in the initial RAM disk environment, so

428

446

care must be taken not to depend on any files or running

429

services not available there.

447

services not available there. Any helper executables required

448

by the plugin (which are not in the <envar>PATH</envar>) can

449

be placed in the plugin helper directory, the name of which

450

will be made available to the plugin via the

451

<envar>MANDOSPLUGINHELPERDIR</envar> environment variable.

430

452

</para>

431

453

<para>

432

454

The plugin must exit cleanly and free all allocated resources

475

497

only passes on its environment to all the plugins. The

476

498

environment passed to plugins can be modified using the

477

499

<option>--global-env</option> and <option>--env-for</option>

478

options.

500

options. Also, the <option>--plugin-helper-dir</option> option

501

will affect the environment variable

502

<envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.

479

503

</para>

480

504

</refsect1>

481

505

572

596

</informalexample>

573

597

574

598

<para>

575

Run plugins from a different directory, read a different

576

configuration file, and add two options to the

599

Read a different configuration file, run plugins from a

600

different directory, specify an alternate plugin helper

601

directory and add two options to the

577

602

<citerefentry><refentrytitle >mandos-client</refentrytitle>

578

603

<manvolnum>8mandos</manvolnum></citerefentry> plugin:

579

604

</para>

580

605

<para>

581

606

582

607

583

<userinput>cd /etc/keys/mandos; &COMMANDNAME; --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>

608

<userinput>cd /etc/keys/mandos; &COMMANDNAME; --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/x86_64-linux-gnu/mandos/plugins.d --plugin-helper-dir /usr/lib/x86_64-linux-gnu/mandos/plugin-helpers --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>

584

609

585

610

</para>

586

611

</informalexample>

Older »