Commit Graph

90 Commits

Author SHA1 Message Date
Booker Bense
fc145e7162 Updating UserGuide with Kerberos v5 authentication
This patchset contains updates to the OpenAFS UserGuide that
explains how to authentication OpenAFS using kinit/aklog
and uses language describing Kerberos outside the context
of the kaserver.  References to applications such as telnet
have been replaced with more modern equivalents such as ssh.

Change-Id: Ifae779b04a26beb9be9cf58b450958acdc477c06
Reviewed-on: http://gerrit.openafs.org/1521
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2010-03-23 21:17:00 -07:00
Jason Edgecombe
5fae0f0b9a Add a section on how to tune the AFS cache using xstat_cm_test
The cache tuning section covers how to use xstat_cm_test to measure
the cache miss percentage.

LICENSE BSD

Change-Id: I895dbbecd7e16d44e18fa65e5e1aa1da5c567a06
Reviewed-on: http://gerrit.openafs.org/1308
Tested-by: Jason Edgecombe <jason@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-03-02 16:23:41 -08:00
Asanka Herath
62e4bf7ddd Fix typo in AdminGuide
</pare> -> </para>

Change-Id: If0f8183f59f038b1b5e033d5ebd2607b5091f6da
Reviewed-on: http://gerrit.openafs.org/1103
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-01-14 16:20:58 -08:00
Simon Wilkinson
9b23804a82 Remove weekly bosserver restarts
Change the default so new installations of the bosserver have
no weekly restarts. Update the manpage and XML documentation to
reflect this change.

FIXES 126138

Change-Id: Ic22b750a602f6d2a22be881f5e1b04cd4fa132ae
Reviewed-on: http://gerrit.openafs.org/1097
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-01-14 07:01:16 -08:00
Simon Wilkinson
99d0070673 Documentation: Fix asetkey syntax
To set a key, use "asetkey add", not just "asetkey"

FIXES 125430

Change-Id: Ifa381ec95f9253bcc5c7a1d374fbf88408f82f67
Reviewed-on: http://gerrit.openafs.org/1045
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-12-29 18:19:36 -08:00
Mickey Lane
ca9a12c422 Fix 2 errors in Windows release Notes
Description of registry key HKLM\ SOFTWARE\ OpenAFS\
Client\ Server Preferences\ File (and \ VLDB) states
"256" - should be 15 - and "ServerPreferences" should
have a space between the words.

Change-Id: Ia2147f920ecc023d26250efaf9815f1b09d1550a
Reviewed-on: http://gerrit.openafs.org/840
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-11-19 08:58:12 -08:00
Jeffrey Altman
d0080431fa Windows: Updates to Release Notes
Add support for Windows 7 and Server 2008 R2.

Improve text in a variety of areas.

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/719
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-23 00:06:38 -07:00
Jeffrey Altman
bb4a5038d9 Add indexing to Windows Release Notes
An initial pass at adding indexing to the Windows release notes.
The next pass should refine the index terms and add appropriate
secondary index values.

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/454
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-09-13 07:34:23 -07:00
Jeffrey Altman
d190d2400e Windows Release Notes XML
Reformat the Registry and Environment Values in Appendix A
so that they are easier to identify in the table of contents.

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/453
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2009-09-13 07:32:01 -07:00
Jason Edgecombe
fb79d6e1f0 Updated Chapter 2, Section 3.4 of the Admin Guide
Added a bullet point explaining the use of a Kerberos cross-realm trust and PTS
foreign groups to give foreign users access.

Replaced a reference to Authentication Database with Kerberos Database.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/381
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-03 11:02:16 -07:00
Jason Edgecombe
d352ca1df4 Updated Chapter 2, Section 3.2 of the Admin Guide
Removed the reference to the Authentication Server and added a reference to the Kerberos Server and Kerberos 5 authentication for foreign clients.

Replaced AFS Product Support with the AFS registrar as the maintainer of the
public CellServDB file. A link was added to grand.central.org for getting the
latest copy of the file and submitting changes for the local site.

Reviewed-on: http://gerrit.openafs.org/379
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-02 16:02:28 -07:00
Jason Edgecombe
67bcc19c75 Updated Chapter 2, Section 3.3 of the Admin Guide
Added text about Freelance Mode and Dynamric Root Mode and the changes they
cause when dealing with mounts to foreign cells in /afs and \\AFS

Reviewed-on: http://gerrit.openafs.org/380
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-01 03:22:58 -07:00
Jeffrey Altman
af8dee05f0 Windows: Release Notes Updates for 1.5.62
Some formatting corrections

Section 3.26 updated to describe limitations caused by Apple
Bonjour on 32-bit Windows.

Section 3.40 updated to mentions Microsoft SMB Redirector
Extended Server Timeout support.

Section 3.41 updated to describe inability of pioctl operations
to succeed on service mapped drives.

Section 3.43 updated to include Windows 7 and Server 2008
in the known issues list.

New section 3.51 on Microsoft RPC Services

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/346
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-08-26 19:37:43 -07:00
Jeffrey Altman
a13d8146a3 Add generated files to doc/xml/AdminGuide .gitignore
Add htmlhelp.hhp, index.hhk, and toc.hhc

Reviewed-on: http://gerrit.openafs.org/259
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-08-02 05:41:53 -07:00
Jeffrey Altman
1c24db09fa Add/Update .gitignore files for Windows builds
Many Windows files were not included in the .gitignore files.
Many directories did not have .gitignore files at all.
Add and update where required.

LICENSE IPL10

Reviewed-on: http://gerrit.openafs.org/103
Verified-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
Reviewed-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
Verified-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-07-15 18:37:16 -06:00
Jason Edgecombe
8a2330a9a6 Updated chapter 2, sections 1-3 of the Admin Guide
Replaced some references to the Authentication Database with Kerberos.
Removed text about obsolete tools like rcp, inetd, and rlogin.
Corrected references to AFS Product support by replacing them with links
to the OpenAFS Support page. Added warnings about using the wrong fsck binary
with inode and namei-based fileserver binaries. Removed an obsolete paragraph
about ThisCell and how it interacts with the Authentication Database.

LICENSE BSD
FIXES 124931

Reviewed-on: http://gerrit.openafs.org/10
Verified-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-14 21:07:50 -06:00
Simon Wilkinson
d5081f264d Remove CVS ignore files
Now we're in git we don't need any cvsignore files any more...

Reviewed-on: http://gerrit.openafs.org/1
Verified-by: Derrick Brashear <shadow@gmail.com>
Reviewed-by: Derrick Brashear <shadow@gmail.com>
2009-07-06 11:03:16 -06:00
Simon Wilkinson
ba9ad62845 Revise git ignore files
Revise our git ignores to match the current state of the tree, and include
entires in the top level for all of the 'dest' directories for all of the
architectures we claim to support.

Reviewed-on: http://gerrit.openafs.org/2
Reviewed-by: Derrick Brashear <shadow@gmail.com>
Verified-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
2009-07-06 10:03:23 -06:00
Simon Wilkinson
c41a467741 gitignore-20090615
LICENSE IPL10

make gitignore files
2009-06-15 23:29:29 +00:00
Jason Edgecombe
d7b3953a53 doc-admin-guide-updates-20090601
LICENSE BSD
FIXES 124889

Updates to chapter one of the Admin Guide.  Remove references to the
Authentication Server, add references to a Kerberos server, revise ntpd
parts to reflect the fact that OpenAFS doesn't ship ntpd, and removed
the distinction between the US and non-US versions of the Update Server.
2009-06-01 23:35:17 +00:00
Russ Allbery
e34fe0f9a8 doc-xml-build-cvsignore-20090601
LICENSE BSD

Ignore new generated files from the documentation build.
2009-06-01 23:31:47 +00:00
Russ Allbery
2520cc9aab doc-xml-version-depends-20090601
LICENSE BSD

Make PDF manual generation also depend on version.xml, matching HTML
generation.
2009-06-01 23:30:42 +00:00
Derrick Brashear
e452c704c5 xml-doc-building-glue-20090527
LICENSE IPL10
FIXES 124804

add configure switches for building docs. generate version files needed.
2009-05-27 20:44:24 +00:00
Jeffrey Altman
e754a0bebd doc-xml-windows-release-notes-20090526
LICENSE MIT

Add notes describing registry support for CellServDB info and
conversion of docs to HtmlHelp format.
2009-05-26 16:29:16 +00:00
Jeffrey Altman
582688f1be windows-xml-release-notes-version-20090525
LICENSE MIT

autogenerate version info.

fix chapter title.
2009-05-26 03:20:06 +00:00
Jeffrey Altman
e4b36071ef doc-xml-version-generation-20090521
LICENSE MIT

Replace version info in the DocBook files with a new ENTITY "version"
associated with a local "version.xml" file which contain a <revision>
tag for the current release.

The version.xml file should be autogenerated by the Makefile system.
2009-05-21 18:51:42 +00:00
Jeffrey Altman
85a10ffc93 doc-xml-windows-20090519
LICENSE IPL10

remove references to xml files no longer in the repository
2009-05-20 05:53:57 +00:00
Russ Allbery
7b56f2ebfc doc-xml-build-20090518
LICENSE MIT

Standardize the UNIX Makefiles for all of the DocBook guides.  Remove the
rest of the generated files and switch to xsltproc and dblatex for the
document generation in all cases.  Fix a few DocBook errors by removing
the contents of the <index> tag and removing the unknown <pubsnumber> tag
in the <revision> field.
2009-05-19 04:58:53 +00:00
Russ Allbery
74585aa500 doc-quick-start-unix-build-20090518
LICENSE MIT

Use dblatex to build PDF documentation instead of docbook2html and xsltproc
to build HTML instead of docbook2html.  Remove all the index generation
logic, since dblatex and xsltproc handle that automatically.  Remove the
contents of the <index> tag in the source, since neither program requires
there be anything in there.

Remove the style sheets and configuration that were used for docbook2*.
2009-05-19 04:27:36 +00:00
Jeffrey Altman
fb985eefce doc-xml-release-notes-windows-20090514
LICENSE MIT

Initial take at converting the OpenAFS for Windows Release Notes
to DocBook.

Website style HTML and HtmlHelp (.chm) output is generated.

Formatting of Registry Value descriptions could be improved.

There is no indexing at present.
2009-05-14 18:47:44 +00:00
Jeffrey Altman
9e8e080a5c doc-xml-20090513
LICENSE IPL10
FIXES 124760

Remove generated HTML from the respository

Update XML to support autogeneration of Index files via XSLT

Add graphics referenced by generated HTML output

Add top level index.html used by the docs.openafs.org web site.

Add NTMakefile for AdminGuide, QuickStartUnix, and UserGuide
that utilizes XSLT to generate Windows HTMLHelp (.CHM) and
website appropriate HTML output.

In AdminGuide and UserGuide, relabel the documentation as OpenAFS
instead of IBM AFS.  Create a new revision entry for the OpenAFS
docs.

Incorporate updates to QuickStartUnix Appendix A
2009-05-14 03:25:35 +00:00
Jason Edgecombe
32c271187a doc-user-guide-acl-example-fix-20081106
FIXES 123331
LICENSE BSD

fs sa takes a directory as its first argument.
2008-11-07 00:26:17 +00:00
Russ Allbery
62ffbc2a46 remove-administration-reference-20080627
LICENSE IPL10

Purge the old AFS Administration Reference documentation.  This has now
been completely replaced by the manual pages.
2008-06-28 07:32:45 +00:00
Russ Allbery
bc585c90cf quickstart-pam-docs-20070507
Flesh out the PAM installation documentation for Linux and Solaris (and a
bit of reformatting in the HP-UX section).
2007-05-07 20:16:02 +00:00
Derrick Brashear
5f919154cf quickstart-solaris-pam-20070423
this actually needs more fleshing out but it's at least a pointer
2007-04-24 04:48:04 +00:00
Simon Wilkinson
f521ac0f60 quickstart-obsolete-appendices-20070423
FIXES 60137

commit updates to the docs for obsolete stuff

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

also the appendix file
2007-04-24 04:37:52 +00:00
Simon Wilkinson
7de756ca28 quickstart-update-20070410
FIXES 58896

update quickstart guide with new information
2007-04-11 03:14:33 +00:00
Russ Allbery
71a1d8a025 docbook-quickguide-cleanup-20061201
Remove generated files from CVS.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

Some initial obvious cleanup.  Removed all the sections on Digital UNIX,
changed IBM AFS to OpenAFS throughout, and reformatted and cleaned up the
front matter and some of the first few pages.
2006-12-02 03:56:17 +00:00
Russ Allbery
f544468443 docbook-quickguide-makefile-20061201
Add some comments to the makefile, set up dependencies to build the index
automatically, remove a bunch of unnecessary @-signs in front of commands,
and add a clean target.
2006-12-02 02:22:34 +00:00
Chas Williams
52557c982e xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first
2006-09-16 01:13:22 +00:00