summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README63
1 files changed, 63 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..21af8c4
--- /dev/null
+++ b/README
@@ -0,0 +1,63 @@
+Hello!
+
+Thanks for downloading Linux-PAM.
+
+NOTES:
+
+How to use it is as follows:
+
+Please look at the ci/install_dependencies.sh for the necessary
+prerequisite packages to be able to build the Linux-PAM. The script
+is targeted at Debian based Linux distributions so the package
+names and availability might differ on other distributions.
+
+If you check out the sources from git, install Autotools and generate
+configuration scripts, ensuring you have the minimum packages installed,
+the ci scripts may help here:
+
+ ./autogen.sh
+
+Then compile:
+
+ ./configure --help | less
+ ./configure <your-options>
+ make
+
+To make sure everything was compiled correct, run:
+
+ make check
+
+If a test fails, you should not continue to install this build.
+These tests require a suitable file /etc/pam.d/other; if necessary,
+create such a file containing, e.g., these five lines (not indented)
+
+ #%PAM-1.0
+ auth required pam_deny.so
+ account required pam_deny.so
+ password required pam_deny.so
+ session required pam_deny.so
+
+
+Note, if you are worried - don't even think about doing the next line
+(most Linux distributions already support PAM out of the box, so if
+something goes wrong with installing the code from this version your
+box may stop working..)
+
+ make install
+
+That said, please report problems to the bug reporting database
+at https://github.com/linux-pam/linux-pam/issues .
+
+You can run additional checks after installing by executing
+
+ make xtests
+
+as root.
+
+WARNING: Running "make xtests" can overwrite configuration data
+or make the system insecure/unfunctional for a short time!
+Backup all important data before!
+
+To regenerate manual pages from the XML source files you need the
+docbook-xsl stylesheets in version 1.69.1 or newer, older versions had
+a bug which generates a broken layout.