| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| module:newslink [2010/02/25 00:50] – Links to network:usenset changed to network:usenet digitalman | module:newslink [2024/11/12 22:05] (current) – A new logo (picture from an airport newstand) digital man |
|---|
| ====== NewsLink ====== | ====== NewsLink - NNTP Gateway ====== |
| | {{:module:newlink_logo2.jpg??500|Another newsstand sign I saw in an airport, long after I named this module}} |
| ====== Background ====== | ====== Background ====== |
| |
| |
| NewsLink is written in 100% JavaScript and the source code (if you're | NewsLink is written in 100% JavaScript and the source code (if you're |
| interested) is contained in the files newslink.js and newsutil.js in the | interested) is contained in the file ''newslink.js'' in the |
| Synchronet EXEC directory. | Synchronet ''[[dir:exec]]'' directory. Current version is always available via [[dev:git]]. |
| |
| |
| |
| |
| 1. Go into SCFG->External Programs->Timed Events and created a timed event | 1. Go into [[:util:SCFG]]->External Programs->Timed Events and created a timed event |
| for NewsLink (if one doesn't already exist). Example: | for NewsLink (if one doesn't already exist). Example: |
| |
| 4: Access Requirements | 4: Access Requirements |
| |
| Note: At this point you may want to login to your New Server with a regular | Note: At this point you may want to login to your News Server with a regular |
| News Client (aka newsreader), retrieve a list of available newsgroups | News Client (aka newsreader), retrieve a list of available newsgroups |
| and make a list of the newsgroups you would like linked into your | and make a list of the newsgroups you would like linked into your |
| BBS's message areas. | BBS's message areas. |
| | An alternate option is to use the provided ''[[dir:exec]]/getnewsgrouplist.js'' script to retrieve a list of newsgroups from your News Server and save those to a file (e.g. ''newsgroup.lst''). Example: |
| | $ jsexec getnewsgrouplist.js user password news.example.com > newsgroup.lst |
| | (Note: the ''getnewsgrouplist.js'' script supports alternate ports and group name filtering options, if you need them) |
| | |
| |
| 3. Now go into SCFG->Message Areas->USENET->Sub-boards and create some | 3. Now go into SCFG->Message Areas->USENET->Sub-boards and create some |
| 12: Purge by Age Disabled | 12: Purge by Age Disabled |
| 13: Duplicate Checking Enabled (10000 message CRCs) | 13: Duplicate Checking Enabled (10000 message CRCs) |
| | |
| | An alternate option here would be to import the ''newsgroup.lst'' file if you have one, using the SCFG "Import Message Areas" option and the "USENET Newsgroup List" file format. |
| |
| 4. For each NewsLinked sub-board, set Network Options->Internet (UUCP/NNTP) | 4. For each NewsLinked sub-board, confirm Network Options->Internet (UUCP/NNTP) is set to "Yes". |
| to "Yes". | |
| |
| 5. Edit your ''[[dir:ctrl]]/[[config:newslink.cfg]]'' file: | 5. Edit your ''[[dir:ctrl]]/[[config:newslink.cfg]]'' file: |
| |
| * Change the "SERVER" line to specify the host name or IP address of the News Server you are linking with. If the News Server is listening on a non-standard TCP port (e.g. other than 119), you will need to add a "PORT" line specifying the TCP port number of the server. | * Change the "SERVER" line to specify the host name or IP address of the News Server you are linking with. If the News Server is listening on a non-standard TCP port (e.g. other than 119), you will need to add a "PORT" line specifying the TCP port number of the server. |
| | * If you wish to use TLS/SSL, uncomment the "TLS" line. This will change the default port to 563. |
| * If the News Server requires an authenticated user login, change the "USER" and "PASS" lines to specify the username and password you use to login to the above News Server. If the "USER" line is missing or commented-out (with a semicolon), then no user authentication will be attempted (sometimes called "anonymous login"). | * If the News Server requires an authenticated user login, change the "USER" and "PASS" lines to specify the username and password you use to login to the above News Server. If the "USER" line is missing or commented-out (with a semicolon), then no user authentication will be attempted (sometimes called "anonymous login"). |
| * For each sub-board you configured in step 3, add an "AREA" line, specifying each sub-board's "Internal Code" (from SCFG->Message Areas). | * For each sub-board you configured in step 3, add an "AREA" line, specifying each sub-board's "Internal Code" (from SCFG->Message Areas). |
| Example: AREA USENET_ALLSYSOP | Example: ''AREA USENET_ALLSYSOP''\\ |
| | (An alternate option here is to use the ''AUTO_AREAS'' keyword which will automatically link all sub-boards flagged as Internet/NNTP networked in SCFG) |
| * By default, NewsLink will only import articles (aka messages) posted *after* the first scan of the newsgroups (i.e. it will not import *any* articles during the first run). If you want NewsLink to import *all* existing articles for *all* linked newsgroups (potentially many *thousands* of messages, depending on the News Server), add the line "FLAGS I" (case insensitive). WARNING: Using this feature may cause the initial NewsLink execution to take a long time to download all the existing articles (potentially many thousands) that may be stored on the News Server. | * By default, NewsLink will only import articles (aka messages) posted *after* the first scan of the newsgroups (i.e. it will not import *any* articles during the first run). If you want NewsLink to import *all* existing articles for *all* linked newsgroups (potentially many *thousands* of messages, depending on the News Server), add the line "FLAGS I" (case insensitive). WARNING: Using this feature may cause the initial NewsLink execution to take a long time to download all the existing articles (potentially many thousands) that may be stored on the News Server. |
| * Remove or comment-out (with a semicolon) the ''DISABLED'' line. | * Remove or comment-out (with a semicolon) on the ''DISABLED'' line (if present). |
| |
| 6. Now you may force the NEWSLINK timed event to run. In SBBSCTRL (Win32 GUI), | 6. Now you may force the NEWSLINK timed event to run. In SBBSCTRL (Win32 GUI), |
| Other supported NewsLink command-line options: | Other supported NewsLink command-line options: |
| |
| -d enable debug output | ^ Option ^ Description ^ |
| -ri reset import pointers (import all) | | ''-d'' | enable debug output | |
| -ui update import pointers (import none) | | ''-ri'' | reset import pointers (import all) | |
| -re reset export pointers (export all) | | ''-ui'' | update import pointers (import none) | |
| -ue update export pointers (export none) | | ''-re'' | reset export pointers (export all) | |
| -ne no e-mail addresses | | ''-ue'' | update export pointers (export none) | |
| -nm no mangling of e-mail addresses (disable anti-SPAM measures) | | ''-ne'' | no e-mail addresses | |
| -um un-mangle e-mail addresses when importing | | ''-nm'' | no mangling of e-mail addresses (disable anti-SPAM measures) | |
| -ix [n] import a fixed number (n) of articles/messages (default is 500) | | ''-um'' | un-mangle e-mail addresses when importing | |
| | | ''-ix //[n]//'' | import a fixed number (n) of articles/messages (default is 500) | |
| |
| |
| ====== Stopping NewsLink ====== | ====== Stopping NewsLink ====== |
| |
| NewsLink can be stopped by "touching" (creating or updating) the file: ''[[dir:data]]/newslink.stop'' | NewsLink can be stopped by "touching" (creating or updating) the semaphore file: ''[[dir:data]]/newslink.stop'' |
| |
| |
| * [[:module:|Modules]] | * [[:module:|Modules]] |
| |
| {{tag>usenet nntp}} | {{tag>usenet nntp jsutil}} |
