File: README.pod

package info (click to toggle)
libconfig-model-openssh-perl 1.241-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 672 kB
  • sloc: perl: 3,198; makefile: 2
file content (143 lines) | stat: -rw-r--r-- 3,041 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
=begin html

<a href="https://travis-ci.org/dod38fr/config-model-openssh"> <img
   src="https://travis-ci.org/dod38fr/config-model-openssh.svg?branch=master">
   </a>

=end html

=head1 Config::Model::OpenSsh - OpenSSH graphical configuration editor

This module provides a graphical configuration editor for:

=over

=item C</etc/ssh/sshd_config>

=item C</etc/ssh/ssh_config>

=item C<~/.ssh/config>

=back

=head1 Installation

=head2 Debian or Ubuntu

As root,type:

 sudo apt install cme libconfig-model-openssh-perl

To get the GUI, you should also do:

 sudo apt install libconfig-model-tkui-perl

=head2 On Mac or Windows

The easiest way is to:

=over

=item *

install Perl from L<ActiveState|http://www.activestate.com/activeperl>,

=item *

Run PPM

=item *

Select and install C<app-cme>, C<config-model-openssh> and C<config-model-tkui>

=back

=head2 Other

You can also install these modules from CPAN:

 cpanm App::Cme
 cpanm Config::Model::OpenSsh
 cpanm Config::Model::TkUI

=head1 Usage

Once this module is installed, you can launch a GUI to edit C</etc/ssh/sshd_config> with:

 $ sudo cme edit sshd

If L<cme> fails to load your C<sshd_config>, you can try L<cme> with
C<-force> option.

Likewise, you can edit your C<~/.ssh/config> file with:

 $ cme edit ssh

Or to edit C</etc/ssh/ssh_config>, run as root:

 $ sudo cme edit system-ssh

More details are given in L<Managing ssh configuration with cme|https://github.com/dod38fr/config-model/wiki/Managing-ssh-configuration-with-cme> wiki page.

=head1 Build from git repository

See L<README-build-from-git|https://github.com/dod38fr/config-model-openssh/blob/master/README-build-from-git.md>.

=head1 More information

For more information, see:

=over

=item *

L<Managing ssh configuration with cme|https://github.com/dod38fr/config-model/wiki/Managing-ssh-configuration-with-cme> wiki page

=item *

L<Using cme|https://github.com/dod38fr/config-model/wiki/Using-cme> wiki page

=item *

L<config-model wiki|https://github.com/dod38fr/config-model/wiki>

=back

=head1 Installation from git

L<Config::Model::OpenSsh> is built with L<Dist::Zilla>.

Please follow the L<instructions to build Config::Model with git|https://github.com/dod38fr/config-model/blob/master/README.build-from-git> to install all modules related to L<Dist::Zilla>.

Then, make sure that L<Config::Model> is installed.

On debian or ubuntu, do:

 sudo apt-get build-dep libconfig-model-openssh-perl

Then run:

 dzil build

If you want to install this software without packaging, you can also run:

 dzil install

=head1 Update OpenSSH model

To update the model, the easiest way is to use the following command in the git repo:

   $ cme meta edit

This command requires L<Config::Model::Itself>.

On  debian or ubuntu, do:

	sudo apt install libconfig-model-itself-perl

Then you can explore the configuration elements in the GUI.

For more information on model update, see this
L<wiki page|https://github.com/dod38fr/config-model/wiki/How-to-add-a-new-parameter-to-an-existing-model>