Skip to content

Commit

Permalink
Misc Non-code impacting changes to docs
Browse files Browse the repository at this point in the history
1. Start to sprinkle https vs. http to encourage a safer web.
Some of this had URLs redone to the wiki as the SSL redirect from freeradius.org
doesn't appear to be consistent. If this is desired then there are more.

2. Misc corrections to links that had become outdated or stale.

3. A few filename renames ( -> .md files)

4. Remove reference to google search box in the mailing list - couldnt find it?

5. Instead of talking about the age of the book - just give the publication date.

6. A few extra bash highlight-isms

Normally I would not batch so much into one commit - but these are all non-code impacting.
  • Loading branch information
jsynack committed Oct 9, 2017
1 parent 392027f commit 4c399d3
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 32 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ topic. The FreeRADIUS community is inclusive by virtue of not being exclusionary
The following behaviours are expected and requested of all community members:

- Ensure that the rules of the community resource you're using have been reviewed in full, [mailing
list guidelines](http://freeradius.org/list/) for the mailing lists, [the guidelines for
list guidelines](https://freeradius.org/support/) for the mailing lists, [the guidelines for
contributing](https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/.github/contributing.md)
for GitHub.
- Use a neutral tone with a focus on technical arguments and technical discussion.
Expand Down
2 changes: 1 addition & 1 deletion CREDITS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Please see:
http://wiki.freeradius.org/project/Acknowledgements
https://wiki.freeradius.org/project/Acknowledgements
5 changes: 2 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ radiusd -X
You should see a lot of text printed on the screen as it starts up.
If you don't, or if you see error messages, please read the FAQ:

http://www.freeradius.org/faq/
https://wiki.freeradius.org/guide/FAQ

If the server says "Ready to process requests.", then it is running
properly. From another shell (or another window), type
Expand Down Expand Up @@ -174,6 +174,5 @@ the configuration files also contain a lot of documentation.
If you have any additional issues, the FAQ is also a good place to
start.

http://www.freeradius.org/faq/

https://wiki.freeradius.org/guide/FAQ

33 changes: 15 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ but be sure to address any warnings when starting v3.0.x before
attempting to use en existing configuration with v4.0.x.

For a list of changes in version 4.0, please see
[doc/changelog](https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/doc/ChangeLog)
[doc/ChangeLog](https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/doc/ChangeLog)

See
[raddb/README.rst](https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/raddb/README.rst)
[raddb/README.md](https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/raddb/README.md)
for information on what to do to update your configuration.

Administrators upgrading from a previous version should install this
Expand All @@ -35,12 +35,13 @@ existing configuration should be carefully migrated to the new
version, in order to take advantage of the new features which can
greatly simply configuration.

Please see http://freeradius.org and http://wiki.freeradius.org for
Please see https://freeradius.org and https://wiki.freeradius.org for
more information.


## Installation
To install the server, please see the INSTALL.md file in this directory.
To install the server, please see the
[INSTALL.md](https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/INSTALL.md) file in this directory.

## Configuring the server
We understand that the server may be difficult to configure,
Expand Down Expand Up @@ -81,25 +82,21 @@ they may be fixed.

Read the FAQ. Many questions are answered there. See the Wiki

http://wiki.freeradius.org
https://wiki.freeradius.org

Read the configuration files. Many parts of the server have NO
documentation, other than comments in the configuration file.

Search the mailing lists. There is a Google link on the bottom of
the page:
Consult the users mailing lists.

http://www.freeradius.org/list/users.html

Type some key words into the search box, and you should find
discussions about common problems and solution.
https://www.freeradius.org/list/users.html


## Feedback, Defects, and Community Support

If you have any comments, or are having difficulty getting FreeRADIUS
to do what you want, please post to the 'freeradius-users' list
(see the URL above). The FreeRADIUS mailing list is operated and
(see the URL above). The FreeRADIUS mailing list is operated and
contributed to, by the FreeRADIUS community. Users of the list will be
more than happy to answer your questions, with the caveat that you've
read documentation relevant to your issue first.
Expand All @@ -110,7 +107,7 @@ freeradius-server
[repository](https://github.com/FreeRADIUS/freeradius-server).

Instructions for gathering data for defect reports can be found in
``doc/bugs`` or on the [wiki](http://wiki.freeradius.org/project/bug-reports).
``doc/bugs.md`` or on the [wiki](https://wiki.freeradius.org/project/bug-reports).

Under no circumstances should the issue tracker be used for support
requests, those questions belong on the user's mailing list. If you
Expand Down Expand Up @@ -142,19 +139,19 @@ same issue.

## Books on RADIUS

See ``doc/README`` for more information about FreeRADIUS.
See ``doc/README.md`` for more information about FreeRADIUS.

There is an O'Reilly book available. It serves as a good
introduction for anyone new to RADIUS. However, it is almost 12 years
old, and is not much more than a basic introduction to the subject.
introduction for anyone new to RADIUS. However, it is from 2002
and is not much more than a basic introduction to the subject.

http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
https://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/

## Commercial support

Technical support, managed systems support, custom deployments,
sponsored feature development and many other commercial services
are available from [Network RADIUS](http://www.networkradius.com).
are available from [Network RADIUS](https://www.networkradius.com).

[CoverityStatus]: https://scan.coverity.com/projects/58/badge.svg? "Coverity Status"
[CoverityStatusLink]: https://scan.coverity.com/projects/58
Expand Down
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation

See the `INSTALL` file, in the parent directory.
See the `INSTALL.md` file, in the parent directory.

# Configuration Files

Expand Down Expand Up @@ -79,7 +79,7 @@ Please do not raise general configuration issues there.
| ``src/main/`` | Source code for the daemon and associated utilities.
| ``src/lib/`` | Source code for the RADIUS library.
| ``src/include/`` | Header files.
| ``src/modules/`` | Dynamic plug-in modules
| ``src/modules/`` | Dynamic plug-in modules.

# Debugging

Expand All @@ -95,6 +95,6 @@ these messages.

For further details, see:

http://www.freeradius.org/faq/
https://www.freeradius.org/faq/

and the `bugs.md` file, in this directory.
12 changes: 6 additions & 6 deletions doc/bugs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

The FreeRADIUS web site is at http://www.freeradius.org, and
The FreeRADIUS web site is at https://www.freeradius.org, and
most information referenced in this document can be found there.

This is primarily for non-developers of the FreeRADIUS server. If you are
Expand All @@ -12,7 +12,7 @@ how to code, then this is the place for you!

Where the server terminates ungracefully due to a bus error,
segmentation violation, or other memory error, you should create
a new issue in the issue tracker http://bugs.freeradius.org,
a new issue in the issue tracker https://bugs.freeradius.org,
including information from the debugging sections below.

For other issues, you should first discuss them on the users list,
Expand All @@ -25,7 +25,7 @@ If the behavior is correct but confusing, we think that's a bug too, and
you should file a bug against our documentation.

For more information about the users list, the lists' archives and the
faq, please visit http://www.freeradius.org/list/users.html
faq, please visit https://www.freeradius.org/list/users.html
Please make sure to READ and RESPECT the house-rules. You will get much
better response and much faster if you do!

Expand Down Expand Up @@ -54,7 +54,7 @@ Enable logging in `gdb` via the following commands:

and follow the instructions in the proceeding section.

You can also enable the "panic_action" given in raddb/radiusd.conf.
You can also enable the "panic_action" given in ``raddb/radiusd.conf``.
See the comments in that file for more details about automatically
collecting gdb debugging information when the server crashes.

Expand Down Expand Up @@ -117,10 +117,10 @@ The output should be printed to the screen, and also sent to the
gdb-radiusd.log file.

You should then submit the information from the log file, along with
any server output, the output of radiusd -xv, and information about your
any server output, the output of ``radiusd -xv``, and information about your
operating system to:

http://bugs.freeradius.org/
https://bugs.freeradius.org/

Submitting it to the bug database ensures that the bug report won't
get forgotten, and that it will be dealt with in due course.
Expand Down

0 comments on commit 4c399d3

Please sign in to comment.