commit: more docs

pull/1/head
Alec Muffett 2017-02-01 13:02:24 +00:00
rodzic 83762af937
commit f0cb03aa54
4 zmienionych plików z 39 dodań i 7 usunięć

8
.gitignore vendored
Wyświetl plik

@ -1,8 +1,8 @@
*.key
*.pem
*.cert
*.conf
*.crt
projects.d
onion-tk.conf
*.key
*.log
*.pem
*~
projects.d

Wyświetl plik

@ -4,7 +4,9 @@
# Status
The code is currently pre-alpha - too hacky for words. It will improve.
The code is currently pre-alpha - too hacky for words.
It will improve.
The goal is to provide a tool for prototyping, and eventually
deploying at scale, HTTP and HTTPS onion sites to provide official
@ -78,3 +80,32 @@ Currently works on OSX with Homebrew:
# Installation: Debian/Raspbian/Ubuntu
Work in progress. Feedback welcome.
# I want to create a new project / my own configuration!
You can either add a new project to the demo config file, or you can
create a new config for yourself.
The simplest configuration file probably looks like this:
```
set project myproject
hardmap secrets.d/xxxxxxxxxxxxxxxx.key foo.com
```
...and if you create a file called `myproject.conf` containing those
files, then you should be able to do:
```
./onion-tk.sh configure myproject.conf
./projects.d/myproject.d/start.sh
```
## But how do I create my own "secrets.d/xxxxxxxxxxxxxxxx.key"?
```
cd secrets.d
./generate-onion-key.sh
```
Do this as many times as you wish/need.

Wyświetl plik

@ -18,7 +18,8 @@ case "$1" in
conf|config|configure)
log=configure$$.log
if ! $EOTK_HOME/tools/do-configure.pl 2>$log ; then
shift
if ! $EOTK_HOME/tools/do-configure.pl "$@" 2>$log ; then
echo $cmd: failure: see $log
exit 1
else

Wyświetl plik

@ -353,7 +353,7 @@ else {
$config = $ARGV[0];
}
die "$config: no such file / missing configuration\n" unless (-f $config);
die "$config: no such file / missing configuration: $config\n" unless (-f $config);
open(CONFIG, $config) or die "$config: $!\n";
chomp(@config = grep(!/^\s*(#.*)?$/, <CONFIG>));