Browse Source

first draft of documentation

sigsegv_dump
Greg Alexander 7 years ago
parent
commit
1485f3f838
  1. 1
      doc/doit
  2. BIN
      doc/icon.png
  3. 77
      doc/index.html

1
doc/doit

@ -0,0 +1 @@
rsync icon.png index.html shed:ga.org/software/simplesshd/

BIN
doc/icon.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

77
doc/index.html

@ -0,0 +1,77 @@
<html><head><title>SimpleSSHD</title></head>
<body>
<p style="float:right;"><img src="icon.png"></p>
<h1>SimpleSSHD</h1>
<p>SimpleSSHD is an SSH2 server based on dropbear that supports scp,
sftp, and rsync. It only supports public-key based authentication (no
password/interactive auth). It does not use root, which means it must
listen on a port over 1024 (defaults to port 2222).</p>
<h2>Quick start</h2>
<ul>
<li> Install SimpleSSHD.
<li> Make a directory <tt>/sdcard/ssh</tt>, and put an
<tt>authorized_keys</tt> file in that directory.
<li> On any computer which will connect to your Android device, set the
port to 2222. With OpenSSH, this can be done by putting these lines in
<tt>~/.ssh/config</tt>:
<pre>
Host myphone
Port 2222
</pre>
<li> Launch SimpleSSHD, and in Settings enable "Start on Boot", and
manually start it for the first time.
<li> You might want to put a <tt>.profile</tt> in <tt>/sdcard/ssh</tt>,
too.
</ul>
<p>Voila! You can use ssh/scp/sftp/rsync to talk to your Android device!</p>
<h3>Configuration</h3>
<p>There are three directory settings that are important for SimpleSSHD.</p>
<p>The first is the path for general dropbear files, which defaults to
<tt>/sdcard/ssh</tt>. Most importantly, this is where
<tt>authorized_keys</tt> is found. It is also where host keys wind up
(they are created on demand), and where temporary files go.</p>
<p>Next is the path to the login shell. The default Android shell is
<tt>/system/bin/sh</tt>, but you may prefer to use the one that come with
busybox or whatever.</p>
<p>Finally is the path for the home directory, which also defaults to
<tt>/sdcard/ssh</tt>. This is where your ssh session starts out, and is
where <tt>.profile</tt> will be found if it is present.</p>
<p>There is also a place where you can put commandline options for
dropbear server. The options which are hardcoded are: <tt>-R -F -p
:portno</tt>. You can use <tt>\</tt> or <tt>"</tt> to escape characters
in this commandline.</p>
<h3>Change Log</h3>
<ul>
<li> <b>2014/12/22 Version 1.0:</b> Initial public release.
</ul>
<h3>About</h3>
<p>SimpleSSHD is built using parts from open source projects: dropbear
server, openssh (for scp and sftp-server), and rsync. Those projects in
turn are based on other projects. A lot of people's work is represented
here, and very little of my own.</p>
<p>But if you find bugs/infelicities, it's probably my fault, so email
me:<br>
<img src="/email.png"></p>
<p>Here is the source. If you use this, email me and I'll make sure you
get the latest:
<br><a href="dropbear-git-20141222.tar.bz2">a 2014/12/22 snapshot of my
git repository</a>
(use <tt>git clone simplesshd.git</tt>).</p>
</body></html>
Loading…
Cancel
Save