more readme

This commit is contained in:
Denis Knauf 2010-03-17 13:27:28 +01:00
parent 3cc2e489b5
commit 27f2157bf8

View file

@ -1,14 +1,12 @@
Dependencies Dependencies
============ ============
incomplete yet.
System System
------ ------
* ruby >= 1.9 (tested: 1.9.1, untested: 1.8 (maybe compatible)) * ruby >= 1.9 (tested: 1.9.1, untested: 1.8 (maybe compatible))
* libdb >= 4 (tested: 4.7) * libdb >= 4.7 (tested: 4.7/4.8)
* C-Compiler * C-Compiler (tested: gcc 4.4.1)
### Debian/Ubuntu: ### Debian/Ubuntu:
@ -20,39 +18,42 @@ Change shebash in s2l.rb to
#!/usr/bin/ruby1.9.1 #!/usr/bin/ruby1.9.1
or
#!/usr/bin/env ruby1.9.1
Ruby Gems Ruby Gems
--------- ---------
* BDB >= 0.2.2 (patch needed - gem included) You should install *dk-bdb* manualy:
* UUIDTools
Install: (in syslog2logan-dir) # gem install dk-bdb -- --with-db-dir=/usr --with-db-include=/usr/include
# gem install bdb-0.2.2.gem uuidtools
Every other dependencies will be installed automaticaly,
if you install syslog2logan via gem.
Install Install
======= =======
# gem build syslog2logan.gemspec # gem install syslog2logan
# gem install syslog2logan-*.gem
Usage Usage
===== =====
First you should know, the database environments are in *this* directory,
where you call *s2l.rb*. You must use this directory for logan itself too!
Don't use this directory for anything else.
Start Start
----- -----
Simple: Simple on Ubuntu:
# ./s2l.rb # /var/lib/gems/1.9*/gems/syslog2logan-*/bin/s2l.rb
Or deamonized: Deamonized:
# sh -c 'nohup ./s2l.rb </dev/null >/dev/null 2>&1 &' &
# sh -c 'nohup PATHTO/s2l.rb </dev/null >/dev/null 2>&1 &' &
Use it Use it
------ ------
@ -67,7 +68,7 @@ You need these lines:
source s_server { source s_server {
unix-stream( "/dev/log" max-connections(100)); unix-stream( "/dev/log" max-connections(100));
# internal(); # Statistics about dests. You've any other dest than the server? # internal(); # Statistics about dests. It's unimportant for LogAn.
file( "/proc/kmsg"); file( "/proc/kmsg");
}; };
@ -80,9 +81,6 @@ You need these lines:
destination( d_server); destination( d_server);
}; };
You should use your default source.
### rsyslog ### rsyslog
I don't know. Please tell me, if you can. I don't know. Please tell me, how to use.