xref: /freebsd/crypto/openssh/contrib/cygwin/README (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1This package describes important Cygwin specific stuff concerning OpenSSH.
2
3The binary package is usually built for recent Cygwin versions and might
4not run on older versions.  Please check http://cygwin.com/ for information
5about current Cygwin releases.
6
7==================
8Host configuration
9==================
10
11If you are installing OpenSSH the first time, you can generate global config
12files and server keys, as well as installing sshd as a service, by running
13
14   /usr/bin/ssh-host-config
15
16Note that this binary archive doesn't contain default config files in /etc.
17That files are only created if ssh-host-config is started.
18
19To support testing and unattended installation ssh-host-config got
20some options:
21
22usage: ssh-host-config [OPTION]...
23Options:
24    --debug  -d            Enable shell's debug output.
25    --yes    -y            Answer all questions with "yes" automatically.
26    --no     -n            Answer all questions with "no" automatically.
27    --cygwin -c <options>  Use "options" as value for CYGWIN environment var.
28    --name   -N <name>     sshd windows service name.
29    --port   -p <n>        sshd listens on port n.
30    --user   -u <account>  privileged user for service, default 'cyg_server'.
31    --pwd    -w <passwd>   Use "pwd" as password for privileged user.
32    --privileged           On Windows XP, require privileged user
33                           instead of LocalSystem for sshd service.
34
35Installing sshd as daemon via ssh-host-config is recommended.
36
37Alternatively you can start sshd via inetd, if you have the inetutils
38package installed.  Just run ssh-host-config, but answer "no" when asked
39to install sshd as service.  The ssh-host-config script also adds the
40required lines to /etc/inetd.conf and /etc/services.
41
42==================
43User configuration
44==================
45
46Any user can simplify creating the own private and public keys by running
47
48  /usr/bin/ssh-user-config
49
50To support testing and unattended installation ssh-user-config got
51some options as well:
52
53usage: ssh-user-config [OPTION]...
54Options:
55    --debug      -d        Enable shell's debug output.
56    --yes        -y        Answer all questions with "yes" automatically.
57    --no         -n        Answer all questions with "no" automatically.
58    --passphrase -p word   Use "word" as passphrase automatically.
59
60Please note that OpenSSH does never use the value of $HOME to
61search for the users configuration files! It always uses the
62value of the pw_dir field in /etc/passwd as the home directory.
63If no home diretory is set in /etc/passwd, the root directory
64is used instead!
65
66================
67Building OpenSSH
68================
69
70Building from source is easy.  Just unpack the source archive, cd to that
71directory, and call cygport:
72
73	cygport openssh.cygport all
74
75You must have installed the following packages to be able to build OpenSSH
76with the aforementioned cygport script:
77
78  zlib
79  crypt
80  openssl-devel
81  libedit-devel
82  libkrb5-devel
83
84Please send requests, error reports etc. to cygwin@cygwin.com.
85
86
87Have fun,
88
89Corinna Vinschen
90Cygwin Developer
91Red Hat Inc.
92