SoylentNews - User contributions [en]

EmergencyProcedures

2019-01-10T16:11:55Z

The Mighty Buzzard: /* If memcached is not running */

[[SystemAdministration]] - parent

==Why This is Here==

In ALL emergency situations, the most qualified person to fix them should be sought out. These instructions are here to cover the hopefully VERY RARE case where that is not possible.

They are deliberately written at a very basic level, probably more basic than anyone with access to the servers would actually need. Howver, it is still useful to have a sort of checklist. The times when services are down tend to be stressful, and humans sometimes do not operate at their best when stressed. Plus, who knows? Maybe someday someone will have to walk the janitor through this...

==What you need to do anything useful==

You need ssh access to the machines affected, with the ability to get root privileges. Without this, there is no way to do anything useful to fix any problem with the system

You must ssh to the appropriate machine, typically to a user account, and then sudo su - to root.

(This ability must be obtained in advance, such information cannot for obvious reasons be placed on a public wiki)

==Slash basic description==

The slash system consists of three separate components:

* A Mysql database server - The database engine which holds most of the data such as articles, users, etc.
* The Apache web server - which handles the web interface
* The slashd daemon, which acts as a timed batch processor for various slash events and tasks.

In addition on the main server, an http caching program called varnish is running, which also must be functional, and running, and a cache program for the database, <strike>memcached</strike>.

* Varnish - an http cache.
* memcached - A database cache

For slash to work, all three components must be running, plus varnish <strike>and memcached</strike> if they are in use.

To tell if they are running, use the command 'pstree' which will show, in condensed form, the tasks that are running.

Here is what the result of the pstree command looks like on the main server:

<pre>
# pstree
init─┬─atd
├─cron
├─dbus-daemon
├─httpd─┬─10*[httpd]
│ └─sh
├─landscape-clien─┬─landscape-broke───2*[{landscape-broke}]
│ ├─landscape-manag
│ └─landscape-monit
├─linode-longview
├─login───bash
├─master─┬─pickup
│ ├─qmgr
│ └─tlsmgr
├─memcached───5*[{memcached}]
├─nginx───4*[nginx]
├─ntpd
├─rsyslogd───3*[{rsyslogd}]
├─slapd───4*[{slapd}]
├─sshd───sshd───sshd───bash───sudo───su───bash───pstree
├─sudo───slashd───3*[slashd]
├─udevd───2*[udevd]
├─upstart-socket-
├─upstart-udev-br
└─varnishd───varnishd───20*[{varnishd}]
</pre>

If you get 'garbage' as the output of the pstree command, use this form instead:
<pre>
[root@slashcode init.d]# pstree -A
</pre>

We can see that apache is running, it shows up as httpd:

<pre>
├─httpd───10*[httpd]
</pre>

And we can see that slashd is running:
<pre>
|-sudo---slashd---3*[slashd]
</pre>

This one is ever so slightly easy to miss, because it is running as a child of the sudo command, so is not first on the list.

On the main server, Varnish must also be running:
<pre>
|─varnishd───varnishd───20*[{varnishd}]
</pre>

<strike>As well as memcached:
<pre>
├─memcached───5*[{memcached}]
</pre></strike>

On the database machine for the main site, we would see that mysql is running,
it shows up like this:
<pre>
├─mysqld_safe───mysqld───37*[{mysqld}]
</pre>

The exact numbers (10*[httpd] etc) are not important.

This is what a properly running system should look like, on the main site. The database is on one machine, which must have mysql running, and and the other machine must have apache (httpd) running, varnish running, <strike>memcached running</strike>, and slashd running.

'''Important note - at the present time, you cannot fix either system by a reboot. Apache MUST be started by hand'''

==Primary site down==

Log in to main slash machine, obtain root.

Check process list:
<pre>
root@soylent-www:/etc/varnish# pstree -A
</pre>

You should see these in process list, among other unrelated processes:
<pre>
├─httpd───10*[httpd]

|-su---slashd---2*[slashd]

|─varnishd───varnishd───20*[{varnishd}]

</pre>

Make sure that slashd, apache, and varnish are running, as described above.

===If only varnishd is not running:===

Restart varnish:
<pre>
# /etc/init.d/varnish start
</pre>

Check that is actually running after a few seconds by looking at the task list again. (pstree)

If varnish will not restart, you will likely need to get help from someone familiar with its configuration.

===If only Apache is not running:===
Start apache:
<pre>
# /srv/soylentnews.org/apache/bin/apachectl start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)

If you get an error message about apache being unable to connect to the database, you will need to ssh into the database machine and restart the database, then come back and restart apache. '''Apache cannot start unless it can make a database connection.'''

=== If only slashd is not running ===

Slashd cannot start unless Apache is running.

To start slashd:
<pre>
# /etc/init.d/slash start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)

Note the command above ends in slash, not slashd. Slash is the name of the script, it starts the daemon known as slashd.

If slashd will not start, make sure apache and the database are running.

You may see some errors when starting slashd, at the present time this is 'normal'. Provided it starts, and seems to operate correctly, there is little that can be done about this until some code fixes are done.

=== If memcached is not running ===
=== memcached is not currently used. ignore this section ===

Restart it:
<pre>
# /etc/init.d/memcached start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)

=== If the database server is not running ===

You will need to ssh to the database machine.

start mysql:
<pre>
# /etc/rc.d/init.d/mysqld start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)
<pre>
├─mysqld_safe───mysqld───37*[{mysqld}]
</pre>

If it will not start, you will need additional help.

You -may- need to restart Apache after restarting the db.

on the main machine:
<pre>
# /srv/soylentnews.org/apache/bin/apachectl stop
wait about ten seconds or check the tasklist that apache is fully stopped
# /srv/soylentnews.org/apache/bin/apachectl start
</pre>

=== None of the above fixes work, or multiple problems ===

In this case it may be worth a try to bring all slash related processes down, and do a cold restart, in the proper order.

Processes are usually stopped in the reverse order they start, so to bring everything down:
<pre>
# /etc/init.d/slash stop
# /srv/soylentnews.org/apache/bin/apachectl stop
# /etc/init.d/varnish stop
# /etc/init.d/memcached stop
# /etc/init.d/mysqld stop
</pre>

And then to bring them all back up:
<pre>
# /etc/init.d/mysqld start
# /etc/init.d/memcached start
# /etc/init.d/varnish start
# /srv/soylentnews.org/apache/bin/apachectl start
# /etc/init.d/slash start
</pre>

If none of this works, you will need help from the assigned sysadmin for the machine.

==Slashcott Development site down==

There are just two differences in this machine and the main site:

* Things are in different locations
* The mysql database server is on the same machine as the site

This is a non-critical machine, so I am just going to list the commands for reference.

Stop Services:
<pre>
# /etc/rc.d/init.d/slash stop
# /usr/local/apache/bin/apachectl stop
# /etc/rc.d/init.d/mysqld stop
</pre>

And then to bring them all back up:
<pre>
# /etc/rc.d/init.d/mysqld start
# /usr/local/apache/bin/apachectl start
# /etc/rc.d/init.d/slash start
</pre>

[[Category:System administration]]

Editors

2017-05-24T09:08:41Z

The Mighty Buzzard: /* Who we are */

The editorial team is responsible for checking and revising (if required) user submitted stories. Prospective editors should be prepared to devote a significant amount of time to checking stories, have a good grasp of the English language, and be familiar with slash's formatting options. Contact: '''editors@soylentnews.org''', or join #editorial in [[SoylentNews:IRC |irc]].

==Who we are==
<section begin=whoweare />
{| class="wikitable" width="100%"
!colspan="3"|'''[[Editors|Editors Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| janrinok
| editor
| UTC+1 (CET)
|-
| mrcoolbp
| editor
| UTC-4 (EST/EDT)
|-
| n1
| editor
| UTC
|-
| martyb
| editor
| UTC-4 (EST/EDT)
|-
| CoolHand
| editor
| UTC-4 (EST/EDT)
|-
| NotSanguine
| editor
| UTC-4 (EST/EDT)
|-
| Cmn32480
| editor
| UTC-4 (EST/EDT)
|-
| takyon
| editor
| ?
|-
| charon
| editor
| UTC-4 (EST/EDT)
|-
| Fnord666
| editor
| UTC-5 (CST/CDT)
|-
| Snow
| editor
| ?
|-
| mrpg
| editor
| ?
|-
| GreatOutdoors
| editor
| ?
|-
| Xyem
| editor
| GMT
|}
<section end=whoweare />

==Retired Members==
Former editors that have lost their roles due to inactivity or retirement
{| class="wikitable" width="100%"
!colspan="3"|'''[[Editors|Retired members]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| Subsentient
| editor
| UTC-7 (MST)
|-
| LaminatorX
| Team Leader
| UTC-5 (CST/CDT)
|-
| Dopefish
| editor
| UTC-8 (PST)
|-
| mattie_p
| editor
| UTC-7 (MST)
|-
| zizban
| editor
| UTC-4 (EST/EDT)
|-
| Azrael
| editor
| ?
|-
| Woods
| editor
| UTC-5 (CST/CDT)
|-
|}

==Projects==

*Continue to develop editorial process (see Documentation below)
*Maintain static pages (FAQ.shtml, about.shtml, and moderation.shtml)

==Documentation==
<section begin=documentation />
*A [[Story_Style|Story Style]] document outlines editorial guidelines, it may need additional refining and ratification eventually.
* [[Editing_Process|The Editing Process]] - builds on the Story Style and Submission Guidelines to describe how the editing process is carried out.
* [[Submission_guidelines|Submission Guidelines]] - Notes to all users regarding the formatting of submissions and relevant rules.
* [[Editorial_Policy|Editorial Policy]] - Policy Statement of the Editorial Team
* [[EditorialHTML|Editorial HTML]] - HTML useful in Story Editing
<section end=documentation />

==Dependencies==
*Main Website (slash)
**[[EditorPrivileges|editor privileges]]

[[Category:Teams]]
[[Category:Editorial team]]

Development

2017-05-24T09:04:26Z

The Mighty Buzzard: /* Who we are */

[[TeamPages]] - parent, [[SystemAdministration]]

==Welcome==
We are currently looking for volunteers to help develop SoylentNews slashcode. Anyone willing is free to help, but '''we really need good perl devs'''. Slashcode is based heavily on perl and most pages have some type of perl code on them. We also seek non-perl devs, there is plenty of stuff that you can do without touching the code too much.

Our code is hosted on GitHub at https://github.com/SoylentNews/slashcode. Have a look and see how you can contribute. Bugs are now on [https://github.com/SoylentNews/slashcode/issues GitHub Bugs].

Volunteers should send an email to [mailto:dev@soylentnews.org dev@soylentnews.org] expressing your areas of interest and what your coding strengths are. Also you can hop onto [[SoylentNews:IRC]] and join the #dev channel. Come by and express your interest to paulej72, audioguy, or [[User:mrcoolbp|mrcoolbp]].

Currently we are undergoing a bit of a reorganization and we hope to have more information available here soon about our short term and long term goals for the code.

== Who we are ==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[Development|Dev Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| paulej72<ref name="paulej72_notes">Working on template and css issues on the site, main bug herder. - email:[mailto:paulej72@soylentnews.org paulej72@soylentnews.org] [[Paulej72WorkNotes]]</ref>
| Team Leader for Dev
| UTC-4 (EST/EDT)
|-
| Ncommander
| Currently on concentrating on admin-ish stuff.
| UTC-5
|-
| martyb/bytram
| primary bug herder, Database (in training)
| UTC-4 (EST/EDT)
|-
| The Mighty Buzzard
| Code Monkey Extraordinaire
| UTC-6 (CST/CDT)
|-
| Xyem
| Code Monkey First Class
| GMT
|}
<section end=whoarewe />

== Index of Development Pages and Resources ==

Note: Any sort of code posted onto the wiki can now be syntax highlighted using the <nowiki><syntaxhighlight></nowiki> tag. It will default to perl, but can be changed to other languages. For example <nowiki><syntaxhighlight lang="sql"></nowiki>. More documentation is at [[mediawikiwiki:Extension:SyntaxHighlight_GeSHi]].

* [[ImportantDevelopmentLinks]] - Place to put urls for the repositories, etc. (Use current page for now, this page not needed - YET)
* [[DevelopmentWorkCurrentlyInProgress]] - what we are working on at this moment
* [[CodingStyleForOurPerlChanges]] - Suggested style for perl code changes
* [[DevelopmentVMHowto]] - How to get your own Slash code up in a Virtual Machine using VirtualBox
* [[CssWork]] - pages for ongoing css work
* [[SlashDocumentationIndex]] - A single place to find Slash docs, one day it will be organized and accurate
* [[IncidentLog]] - Documentation of how incidents occurred and how they were mitigated
* [[GitUse]] - Tutorial/advice on how to use git
* [[Dev/Sys|To-do]] - A list of items in the pipeline collected from various places

== Work Notes ==

* [[AudioGuyWorkNotes]]
* [[Paulej72WorkNotes]]

== Resources ==

* [[SystemAdministration]] - See this section for actual server details and procedures
* GitHub https://github.com/SoylentNews/slashcode: Slashcode Repository and Issue Tracker
* Wiki: Documentation and work logs
**hosted on the svc linode
* IRC: real time chat for team communications
* Slashcott.org: temporary testing server in use until we get ones setup on Linode.
* Mailman Dev Mailing list: for non-real-time discussions that need a good paper trail.
* http://dev.mysql.com/doc/refman/5.5/en/index.html - Official docs for mysql we use
* https://perl.apache.org/start/index.html - modperl docs (We use version 1 with Apache 1.3)
* http://remote.demmers.org/~audioguy/manual/ - Apache 1.3 docs don't seem to be on the Apache site any more, here they are.
** http://remote.demmers.org/~audioguy/manual/misc/API.html but this is what is important to understand slash workings with mod perl.

== Slashcode Primer ==

Slashcode is a complex beast. Here is the listing of the repo:

<blockquote><code><pre>Bundle
Slash
bin
docs
httpd
plugins
sbin
sql
tagboxes
themes
utils
</pre></code></blockquote>

We really are only concerned with three of these directories: Slash, plugins, and themes. The first directory, Slash, is the home of the slash.pm module and its related code. The module, slash.pm, does all of the back end work of slashcode. It provides a set of APIs that are used to generate pages and manipulate the database. This is where the heavy perl coding is done. We definitely need help with this section in both expanding our knowledge and working with the code. (As I started on this from a css/html slant I do not have a good idea of what is here --pauej72)

The second main part of the system are the themes. In this case we have only one theme called slashcode. The theme is broken down into pieces the first is htdocs. htdocs is all of the static html files, perl files that directly start page generation events, the css files, images, and other static code. The second part of the theme is the templates. These templates are loaded into the database an are used by slash to layout the data from different sources and turn them into html files that apache can send to the user. Templates re a mixture of perl, slash coding, and html. Templates use slash calls to load other templates and usually each template leaves a breadcrumb in the final html with a start and end comment with the template's name and id. These breadcrumbs make it easy to find out which template file is generating the particular piece of html that you need to change.

Slashcode also has a plugin architecture that allows certain system to be bolted on to the main system. The main system is basically articles, comments and users. The pulgins add the admin interface, the messaging system, enhanced login, journals, and other things. The files for these plugging are in the plugins folder, not in the theme folder. The issue with plugins is that it contains both front end code such as templates, css and pl files, it also has perl modules that are loaded into the perl engine.

The rest of the directories are used for build and install purposes and probably will not need to be modified regularly.

This is a work in progress so please check back here for more.

== Development VM ==

Please see [[DevelopmentVMHowto]] for the full How To.

Additional notes: http://soylentnews.org/~crutchy/journal/114

==Integrated Development Environment==

'''Note''' This is a work in progress. Currently the Windows development environment seems mostly useless except for Syntax Highlighting and basic Code Navigation.

:Regardless of what IDE (''Integrated Development Environment'') you choose to go with, you're going to require a Perl interpreter (With a built-in Debugger) and optionally the PadWalker module for variable inspection (Also used by built-in debugger).

=== Perl (Interpreter) ===
:Linux users generally already have a full Perl stack installed, so this resource is for Windows users. There's a number of different Perl interpreters available for Windows users. You can download ActivePerl for free below:

::* [http://www.activestate.com/activeperl/downloads www.activestate.com/activeperl/downloads]

=== PadWalker (Variable Inspection) ===
:* [http://perlmaven.com/padwalker perlmaven.com/padwalker]

=== IDEs ===
==== Eclipse ====
:Eclipse with the ''EPIC'' Plug-In provides a great Perl IDE for Windows users. After installing ActivePerl and the PadWalker module you will need to install a Java Runtime.

:'''Before you Begin:''' It's important to note that if you are running 64-bit Windows, you should choose the 64-bit JRE and pair it with a 64-bit Eclipse. They cannot be mis-matched (A 32-bit JRE with a 64-bit Eclipse or vice versa).

:'''Step 1)''':
:: Download Oracle's runtime for free below. You can choose the JRE (Runtime Environment) if you only want to do Perl/Slashcode development or the JDK (Development Kit) if you want to do Perl/Slashcode development and Java development in the future. Choosing the JRE will save you disk space:
:: [http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html Java Runtime Environment 7u55]
:: [http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html Java Developer Kit 7u55]

:'''Step 1.1)''':
:: After you have installed the JRE and restarted Windows, follow this guide from Oracle to setup the environment variables for Windows, including the PATH and CLASSPATH variables:
:: [http://docs.oracle.com/javase/tutorial/essential/environment/paths.html Environment Paths]

:'''Step 2)''':
:: Install the Eclipse IDE. You can download the latest release (Kepler) for free below:
:: [http://eclipse.org/downloads/packages/eclipse-standard-432/keplersr2 Eclipse Kepler]

:'''Step 3)''':
::Install the free ''"EPIC"'' plug-in for Eclipse. This is done from within Eclipse and is fairly straight forward. From within Eclipse, click the "Help" top strip-menu and choose the "Install New Software" option. You can also find detailed instructions below, however they may become out of date:
:: [http://www.epic-ide.org/download.php www.epic-ide.org/download.php] 
==== Geany ====
::As an alternative to Eclipse, you can try Geany. Geany isn't exactly a full IDE like Eclipse, however you can setup the file locations of Perl and get a pretty good workflow going. You can download Geany for free below:

::: [http://www.geany.org/Download/Releases www.geany.org/Download/Releases]

==Notes==
<references />

[[Category:Development]]
[[Category:Teams]]

IRC

2016-08-14T14:17:07Z

The Mighty Buzzard: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

* Official channels are usually safe for work / kids / family.

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! NSFW !! Description !! Maintained by
|-
| ## || yes || mostly about bacon and stuff || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || yes || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || no || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || no || bot error spew || [[User:chromas|chromas]]
|-
| #comments || no || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || no || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

* NSFW = not safe for work / kids /family (contains adult themes and profanity)

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting (if dumping errors to #debug, bots should ideally be set to not respond to commands in that channel to prevent race/infinite loop conditions).

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* # 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
* #smake 
* #smakeadd 
* #sammich 
* #sammichadd 
* #join 
* #part 
* #youtube 
* #g 
* #submit 
* #roll 
* #bnk 
* #tell 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

SystemAdministration-OLD-2024

2016-07-28T10:02:49Z

The Mighty Buzzard: /* Stuff That Needs To Be Addressed */

[[TeamPages]] - parent, [[Development]]

==Welcome==

This is a comphensive index dealing with aspects of system administration and management of our clusters, as well as some of the more archine bits of setup required to make it work.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[SystemAdministration|Sysop Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:paulej72|paulej72]]
| Co-leader
| UTC-4 (EDT)
|-
| mechanicjay
| Co-leader
| UTC-4 (EST/EDT)
|-
| NCommander
| Member
| UTC-9 (AKDT)
|-
| Audioguy
| Member
| UTC-7 (PST/PDT)
|-
| The Mighty Buzzard
| Emergency Reserve Member
| UTC-5 (CST/CDT)
|-
| martyb/bytram
| Catastrophe Reserve Member
| UTC-4 (EST/EDT)
|}
<section end=whoarewe />

==Index of Development Pages and Resources==

===Servers===

List of servers on linode: [http://wiki.soylentnews.org/wiki/Category:SystemAdministration/Servers Category:SystemAdministration/Servers]
* [[soylent-www]] - Primary Apache, mysqld, and varnish servers for main site. Fluorine hosts slashd and ipnd as well.
:: [[Hydrogen]], [[Fluorine]]
* soylent-db -- ndb-cluster servers for mysql, hold the rehash database.
:: [[Helium]], [[Neon]]
* dev -- Development server.
:: [[Lithium]]
* staff-slash -- Staff server, ssh entry point, staff-only rehash.
:: [[Boron]]
* irc -- IRC server and related services.
:: [[Beryllium]]
* [[SystemAdministration/Backups|backups]] -- Backup services. (NOT on linode)
:: [[Oxygen]]
* directory services -- Hesoid and Kerberos.
:: [[Helium]], [[Boron]]
* [[soylent-services]] - mail, wiki, other services as needed.
:: [[Beryllium]]
* [[load-balancer]]
:: [[Sodium]], [[Magnesium]]

==Stuff That Needs To Be Addressed==
* <strike>https is not default everywhere</strike>
* icinga/monitoring project needs <strike>killed</strike> revamped into usefulness
* Landscape - I appreciate NCommanders ability to obtain a product normally sold for free, but if this is not being used it should not be running and using resources. (helium (killed here), perhaps others)
* <strike>Should have some sort of SN password safe</strike>
* Privilege Duplication - making sure that all services have multiple admins
* Systems Documentation needs to revised and brought up to date.
* Work Coordination, not always good communication when fundamental things change.
* <strike>There is no firewall coding at all. Something I normally set up before even one network cable is plugged in. I understand the desire to have an open system on public interfaces, but I see no reason that systems not publicly accessible such as database backends should not be firewalled off from Chinese and other such hackers. Such as the attempts being made on Helium from 120.192.20.162 120.192.0.0/11 China Mobile communications corporation at the moment I am writing this.</strike>

==Work Notes==
DNS is completely run and managed by Linode's DNS Manager service. This was an expedient decision when trying to get off bluehost. We may want to investigate putting the master zone file on helium or boron and having external services handle serving out our dns.

==Resources==
* [[SystemAdministration/AccessInstruction|Access Instructions]] - how to get on the nodes, get around, and kerberos for users primer
* [[SystemAdministration/GroupPermissions|Group Permissions]] - understanding our LDAP groups, what machines they can access, and where you can sudo
* [[SystemAdministration/LDAPManagementForDummies|LDAP Management for Dummies]] - how to do basic shit in that source of miserary known as LDAP
* [[SystemAdministration/TheRiseAndFallOfNewNodeManagement|The Rise And Fall Of New Node Management]] - from bash to fully intergrated node, this doc has it
* [[SystemAdministration/TheHitchhikersGuideToTheli694-22Domain|The Hitchhikerr's Guide to The li694-22 Domain]] - machine list, general information
* [[SystemAdministration/KerberosAdministration|Kerberos Administration Or Everything You Wanted To Know About Kerberos But Were Afraid To Ask]]
* [[DnsRecords]] - copy of the zone file pasted from the machine that was accidentally turned off
* [[EmergencyProcedures|Emergency Technical Procedures]] - in case of fire, break glass (Read before messing with servers)
* [[SystemAdministration/Backups|Backup Information]] - information on where and what is being backed up.

[[Category:Teams]]
[[Category:System administration]]

SystemAdministration-OLD-2024

2016-07-28T09:58:11Z

The Mighty Buzzard: /* Who we are */

[[TeamPages]] - parent, [[Development]]

==Welcome==

This is a comphensive index dealing with aspects of system administration and management of our clusters, as well as some of the more archine bits of setup required to make it work.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[SystemAdministration|Sysop Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:paulej72|paulej72]]
| Co-leader
| UTC-4 (EDT)
|-
| mechanicjay
| Co-leader
| UTC-4 (EST/EDT)
|-
| NCommander
| Member
| UTC-9 (AKDT)
|-
| Audioguy
| Member
| UTC-7 (PST/PDT)
|-
| The Mighty Buzzard
| Emergency Reserve Member
| UTC-5 (CST/CDT)
|-
| martyb/bytram
| Catastrophe Reserve Member
| UTC-4 (EST/EDT)
|}
<section end=whoarewe />

==Index of Development Pages and Resources==

===Servers===

List of servers on linode: [http://wiki.soylentnews.org/wiki/Category:SystemAdministration/Servers Category:SystemAdministration/Servers]
* [[soylent-www]] - Primary Apache, mysqld, and varnish servers for main site. Fluorine hosts slashd and ipnd as well.
:: [[Hydrogen]], [[Fluorine]]
* soylent-db -- ndb-cluster servers for mysql, hold the rehash database.
:: [[Helium]], [[Neon]]
* dev -- Development server.
:: [[Lithium]]
* staff-slash -- Staff server, ssh entry point, staff-only rehash.
:: [[Boron]]
* irc -- IRC server and related services.
:: [[Beryllium]]
* [[SystemAdministration/Backups|backups]] -- Backup services. (NOT on linode)
:: [[Oxygen]]
* directory services -- Hesoid and Kerberos.
:: [[Helium]], [[Boron]]
* [[soylent-services]] - mail, wiki, other services as needed.
:: [[Beryllium]]
* [[load-balancer]]
:: [[Sodium]], [[Magnesium]]

==Stuff That Needs To Be Addressed==
* https is not default everywhere
* icinga/monitoring project needs killed
* Landscape - I appreciate NCommanders ability to obtain a product normally sold for free, but if this is not being used it should not be running and using resources. (helium (killed here), perhaps others)
* Should have some sort of SN password safe
* Privilege Duplication - making sure that all services have multiple admins
* Systems Documentation needs to revised and brought up to date.
* Work Coordination, not always good communication when fundamental things change.
* There is no firewall coding at all. Something I normally set up before even one network cable is plugged in. I understand the desire to have an open system on public interfaces, but I see no reason that systems not publicly accessible such as database backends should not be firewalled off from Chinese and other such hackers. Such as the attempts being made on Helium from 120.192.20.162 120.192.0.0/11 China Mobile communications corporation at the moment I am writing this.

==Work Notes==
DNS is completely run and managed by Linode's DNS Manager service. This was an expedient decision when trying to get off bluehost. We may want to investigate putting the master zone file on helium or boron and having external services handle serving out our dns.

==Resources==
* [[SystemAdministration/AccessInstruction|Access Instructions]] - how to get on the nodes, get around, and kerberos for users primer
* [[SystemAdministration/GroupPermissions|Group Permissions]] - understanding our LDAP groups, what machines they can access, and where you can sudo
* [[SystemAdministration/LDAPManagementForDummies|LDAP Management for Dummies]] - how to do basic shit in that source of miserary known as LDAP
* [[SystemAdministration/TheRiseAndFallOfNewNodeManagement|The Rise And Fall Of New Node Management]] - from bash to fully intergrated node, this doc has it
* [[SystemAdministration/TheHitchhikersGuideToTheli694-22Domain|The Hitchhikerr's Guide to The li694-22 Domain]] - machine list, general information
* [[SystemAdministration/KerberosAdministration|Kerberos Administration Or Everything You Wanted To Know About Kerberos But Were Afraid To Ask]]
* [[DnsRecords]] - copy of the zone file pasted from the machine that was accidentally turned off
* [[EmergencyProcedures|Emergency Technical Procedures]] - in case of fire, break glass (Read before messing with servers)
* [[SystemAdministration/Backups|Backup Information]] - information on where and what is being backed up.

[[Category:Teams]]
[[Category:System administration]]

SystemAdministration-OLD-2024

2016-05-29T12:50:44Z

The Mighty Buzzard: /* Servers */

[[TeamPages]] - parent, [[Development]]

==Welcome==

This is a comphensive index dealing with aspects of system administration and management of our clusters, as well as some of the more archine bits of setup required to make it work.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[SystemAdministration|Sysop Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:paulej72|paulej72]]
| Co-leader
| UTC-4 (EDT)
|-
| mechanicjay
| Co-leader
| UTC-4 (EST/EDT)
|-
| NCommander
| Member
| UTC-9 (AKDT)
|-
| Audioguy
| Member
| UTC-7 (PST/PDT)
|}
<section end=whoarewe />

==Index of Development Pages and Resources==

===Servers===

List of servers on linode: [http://wiki.soylentnews.org/wiki/Category:SystemAdministration/Servers Category:SystemAdministration/Servers]
* [[soylent-www]] - Primary Apache, mysqld, and varnish servers for main site. Fluorine hosts slashd and ipnd as well.
:: [[Hydrogen]], [[Fluorine]]
* soylent-db -- ndb-cluster servers for mysql, hold the rehash database.
:: [[Helium]], [[Neon]]
* dev -- Development server.
:: [[Lithium]]
* staff-slash -- Staff server, ssh entry point, staff-only rehash.
:: [[Boron]]
* irc -- IRC server and related services.
:: [[Beryllium]]
* [[SystemAdministration/Backups|backups]] -- Backup services. (NOT on linode)
:: [[Oxygen]]
* directory services -- Hesoid and Kerberos.
:: [[Helium]], [[Boron]]
* [[soylent-services]] - mail, wiki, other services as needed.
:: [[Beryllium]]
* [[load-balancer]]
:: [[Sodium]], [[Magnesium]]

==Stuff That Needs To Be Addressed==
* https is not default everywhere
* icinga/monitoring project needs killed
* Landscape - I appreciate NCommanders ability to obtain a product normally sold for free, but if this is not being used it should not be running and using resources. (helium (killed here), perhaps others)
* Should have some sort of SN password safe
* Privilege Duplication - making sure that all services have multiple admins
* Systems Documentation needs to revised and brought up to date.
* Work Coordination, not always good communication when fundamental things change.
* There is no firewall coding at all. Something I normally set up before even one network cable is plugged in. I understand the desire to have an open system on public interfaces, but I see no reason that systems not publicly accessible such as database backends should not be firewalled off from Chinese and other such hackers. Such as the attempts being made on Helium from 120.192.20.162 120.192.0.0/11 China Mobile communications corporation at the moment I am writing this.

==Work Notes==
DNS is completely run and managed by Linode's DNS Manager service. This was an expedient decision when trying to get off bluehost. We may want to investigate putting the master zone file on helium or boron and having external services handle serving out our dns.

==Resources==
* [[SystemAdministration/AccessInstruction|Access Instructions]] - how to get on the nodes, get around, and kerberos for users primer
* [[SystemAdministration/GroupPermissions|Group Permissions]] - understanding our LDAP groups, what machines they can access, and where you can sudo
* [[SystemAdministration/LDAPManagementForDummies|LDAP Management for Dummies]] - how to do basic shit in that source of miserary known as LDAP
* [[SystemAdministration/TheRiseAndFallOfNewNodeManagement|The Rise And Fall Of New Node Management]] - from bash to fully intergrated node, this doc has it
* [[SystemAdministration/TheHitchhikersGuideToTheli694-22Domain|The Hitchhikerr's Guide to The li694-22 Domain]] - machine list, general information
* [[SystemAdministration/KerberosAdministration|Kerberos Administration Or Everything You Wanted To Know About Kerberos But Were Afraid To Ask]]
* [[DnsRecords]] - copy of the zone file pasted from the machine that was accidentally turned off
* [[EmergencyProcedures|Emergency Technical Procedures]] - in case of fire, break glass (Read before messing with servers)
* [[SystemAdministration/Backups|Backup Information]] - information on where and what is being backed up.

[[Category:Teams]]
[[Category:System administration]]

SystemAdministration-OLD-2024

2016-05-29T12:48:20Z

The Mighty Buzzard: /* Servers */

[[TeamPages]] - parent, [[Development]]

==Welcome==

This is a comphensive index dealing with aspects of system administration and management of our clusters, as well as some of the more archine bits of setup required to make it work.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[SystemAdministration|Sysop Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:paulej72|paulej72]]
| Co-leader
| UTC-4 (EDT)
|-
| mechanicjay
| Co-leader
| UTC-4 (EST/EDT)
|-
| NCommander
| Member
| UTC-9 (AKDT)
|-
| Audioguy
| Member
| UTC-7 (PST/PDT)
|}
<section end=whoarewe />

==Index of Development Pages and Resources==

===Servers===

List of servers on linode: [http://wiki.soylentnews.org/wiki/Category:SystemAdministration/Servers Category:SystemAdministration/Servers]
* [[soylent-www]] - Primary Apache, mysqld, and varnish servers for main site. Fluorine hosts slashd and ipnd as well.
:: [[Hydrogen]], [[Fluorine]]
* soylent-db -- ndb-cluster servers for mysql, hold the rehash database.
:: [[Helium]], [[Neon]]
* dev -- Development server.
:: [[Lithium]]
* staff-slash -- Staff server, ssh entry point, staff-only rehash.
:: [[Boron]]
* irc -- IRC server and related services.
:: [[Beryllium]]
* [[SystemAdministration/Backups|backups]] -- Backup services.
:: [[Oxygen]]
* directory services -- Hesoid and Kerberos.
:: [[Helium]], [[Boron]]
* [[soylent-services]] - mail, wiki, other services as needed.
:: [[Beryllium]]
* [[load-balancer]]
:: [[Sodium]], [[Magnesium]]

==Stuff That Needs To Be Addressed==
* https is not default everywhere
* icinga/monitoring project needs killed
* Landscape - I appreciate NCommanders ability to obtain a product normally sold for free, but if this is not being used it should not be running and using resources. (helium (killed here), perhaps others)
* Should have some sort of SN password safe
* Privilege Duplication - making sure that all services have multiple admins
* Systems Documentation needs to revised and brought up to date.
* Work Coordination, not always good communication when fundamental things change.
* There is no firewall coding at all. Something I normally set up before even one network cable is plugged in. I understand the desire to have an open system on public interfaces, but I see no reason that systems not publicly accessible such as database backends should not be firewalled off from Chinese and other such hackers. Such as the attempts being made on Helium from 120.192.20.162 120.192.0.0/11 China Mobile communications corporation at the moment I am writing this.

==Work Notes==
DNS is completely run and managed by Linode's DNS Manager service. This was an expedient decision when trying to get off bluehost. We may want to investigate putting the master zone file on helium or boron and having external services handle serving out our dns.

==Resources==
* [[SystemAdministration/AccessInstruction|Access Instructions]] - how to get on the nodes, get around, and kerberos for users primer
* [[SystemAdministration/GroupPermissions|Group Permissions]] - understanding our LDAP groups, what machines they can access, and where you can sudo
* [[SystemAdministration/LDAPManagementForDummies|LDAP Management for Dummies]] - how to do basic shit in that source of miserary known as LDAP
* [[SystemAdministration/TheRiseAndFallOfNewNodeManagement|The Rise And Fall Of New Node Management]] - from bash to fully intergrated node, this doc has it
* [[SystemAdministration/TheHitchhikersGuideToTheli694-22Domain|The Hitchhikerr's Guide to The li694-22 Domain]] - machine list, general information
* [[SystemAdministration/KerberosAdministration|Kerberos Administration Or Everything You Wanted To Know About Kerberos But Were Afraid To Ask]]
* [[DnsRecords]] - copy of the zone file pasted from the machine that was accidentally turned off
* [[EmergencyProcedures|Emergency Technical Procedures]] - in case of fire, break glass (Read before messing with servers)
* [[SystemAdministration/Backups|Backup Information]] - information on where and what is being backed up.

[[Category:Teams]]
[[Category:System administration]]

EmergencyProcedures

2016-05-27T15:54:40Z

The Mighty Buzzard: We're not currently using memcached

[[SystemAdministration]] - parent

==Why This is Here==

In ALL emergency situations, the most qualified person to fix them should be sought out. These instructions are here to cover the hopefully VERY RARE case where that is not possible.

They are deliberately written at a very basic level, probably more basic than anyone with access to the servers would actually need. Howver, it is still useful to have a sort of checklist. The times when services are down tend to be stressful, and humans sometimes do not operate at their best when stressed. Plus, who knows? Maybe someday someone will have to walk the janitor through this...

==What you need to do anything useful==

You need ssh access to the machines affected, with the ability to get root privileges. Without this, there is no way to do anything useful to fix any problem with the system

You must ssh to the appropriate machine, typically to a user account, and then sudo su - to root.

(This ability must be obtained in advance, such information cannot for obvious reasons be placed on a public wiki)

==Slash basic description==

The slash system consists of three separate components:

* A Mysql database server - The database engine which holds most of the data such as articles, users, etc.
* The Apache web server - which handles the web interface
* The slashd daemon, which acts as a timed batch processor for various slash events and tasks.

In addition on the main server, an http caching program called varnish is running, which also must be functional, and running, and a cache program for the database, <strike>memcached</strike>.

* Varnish - an http cache.
* memcached - A database cache

For slash to work, all three components must be running, plus varnish <strike>and memcached</strike> if they are in use.

To tell if they are running, use the command 'pstree' which will show, in condensed form, the tasks that are running.

Here is what the result of the pstree command looks like on the main server:

<pre>
# pstree
init─┬─atd
├─cron
├─dbus-daemon
├─httpd─┬─10*[httpd]
│ └─sh
├─landscape-clien─┬─landscape-broke───2*[{landscape-broke}]
│ ├─landscape-manag
│ └─landscape-monit
├─linode-longview
├─login───bash
├─master─┬─pickup
│ ├─qmgr
│ └─tlsmgr
├─memcached───5*[{memcached}]
├─nginx───4*[nginx]
├─ntpd
├─rsyslogd───3*[{rsyslogd}]
├─slapd───4*[{slapd}]
├─sshd───sshd───sshd───bash───sudo───su───bash───pstree
├─sudo───slashd───3*[slashd]
├─udevd───2*[udevd]
├─upstart-socket-
├─upstart-udev-br
└─varnishd───varnishd───20*[{varnishd}]
</pre>

If you get 'garbage' as the output of the pstree command, use this form instead:
<pre>
[root@slashcode init.d]# pstree -A
</pre>

We can see that apache is running, it shows up as httpd:

<pre>
├─httpd───10*[httpd]
</pre>

And we can see that slashd is running:
<pre>
|-sudo---slashd---3*[slashd]
</pre>

This one is ever so slightly easy to miss, because it is running as a child of the sudo command, so is not first on the list.

On the main server, Varnish must also be running:
<pre>
|─varnishd───varnishd───20*[{varnishd}]
</pre>

<strike>As well as memcached:
<pre>
├─memcached───5*[{memcached}]
</pre></strike>

On the database machine for the main site, we would see that mysql is running,
it shows up like this:
<pre>
├─mysqld_safe───mysqld───37*[{mysqld}]
</pre>

The exact numbers (10*[httpd] etc) are not important.

This is what a properly running system should look like, on the main site. The database is on one machine, which must have mysql running, and and the other machine must have apache (httpd) running, varnish running, <strike>memcached running</strike>, and slashd running.

'''Important note - at the present time, you cannot fix either system by a reboot. Apache MUST be started by hand'''

==Primary site down==

Log in to main slash machine, obtain root.

Check process list:
<pre>
root@soylent-www:/etc/varnish# pstree -A
</pre>

You should see these in process list, among other unrelated processes:
<pre>
├─httpd───10*[httpd]

|-su---slashd---2*[slashd]

|─varnishd───varnishd───20*[{varnishd}]

</pre>

Make sure that slashd, apache, and varnish are running, as described above.

===If only varnishd is not running:===

Restart varnish:
<pre>
# /etc/init.d/varnish start
</pre>

Check that is actually running after a few seconds by looking at the task list again. (pstree)

If varnish will not restart, you will likely need to get help from someone familiar with its configuration.

===If only Apache is not running:===
Start apache:
<pre>
# /srv/soylentnews.org/apache/bin/apachectl start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)

If you get an error message about apache being unable to connect to the database, you will need to ssh into the database machine and restart the database, then come back and restart apache. '''Apache cannot start unless it can make a database connection.'''

=== If only slashd is not running ===

Slashd cannot start unless Apache is running.

To start slashd:
<pre>
# /etc/init.d/slash start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)

Note the command above ends in slash, not slashd. Slash is the name of the script, it starts the daemon known as slashd.

If slashd will not start, make sure apache and the database are running.

You may see some errors when starting slashd, at the present time this is 'normal'. Provided it starts, and seems to operate correctly, there is little that can be done about this until some code fixes are done.

=== If memcached is not running ===

Restart it:
<pre>
# /etc/init.d/memcached start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)

=== If the database server is not running ===

You will need to ssh to the database machine.

start mysql:
<pre>
# /etc/rc.d/init.d/mysqld start
</pre>

Confirm it is running after a few seconds by looking at the process list again. (pstree)
<pre>
├─mysqld_safe───mysqld───37*[{mysqld}]
</pre>

If it will not start, you will need additional help.

You -may- need to restart Apache after restarting the db.

on the main machine:
<pre>
# /srv/soylentnews.org/apache/bin/apachectl stop
wait about ten seconds or check the tasklist that apache is fully stopped
# /srv/soylentnews.org/apache/bin/apachectl start
</pre>

=== None of the above fixes work, or multiple problems ===

In this case it may be worth a try to bring all slash related processes down, and do a cold restart, in the proper order.

Processes are usually stopped in the reverse order they start, so to bring everything down:
<pre>
# /etc/init.d/slash stop
# /srv/soylentnews.org/apache/bin/apachectl stop
# /etc/init.d/varnish stop
# /etc/init.d/memcached stop
# /etc/init.d/mysqld stop
</pre>

And then to bring them all back up:
<pre>
# /etc/init.d/mysqld start
# /etc/init.d/memcached start
# /etc/init.d/varnish start
# /srv/soylentnews.org/apache/bin/apachectl start
# /etc/init.d/slash start
</pre>

If none of this works, you will need help from the assigned sysadmin for the machine.

==Slashcott Development site down==

There are just two differences in this machine and the main site:

* Things are in different locations
* The mysql database server is on the same machine as the site

This is a non-critical machine, so I am just going to list the commands for reference.

Stop Services:
<pre>
# /etc/rc.d/init.d/slash stop
# /usr/local/apache/bin/apachectl stop
# /etc/rc.d/init.d/mysqld stop
</pre>

And then to bring them all back up:
<pre>
# /etc/rc.d/init.d/mysqld start
# /usr/local/apache/bin/apachectl start
# /etc/rc.d/init.d/slash start
</pre>

[[Category:System administration]]

SoylentNews

2016-05-27T00:19:32Z

The Mighty Buzzard: /* Useful Links */

This is a home for information about how '''[http://soylentnews.org SoylentNews.org]''' was started, the vision for it, and discussion about it's future.

==About SoylentNews.org==

Welcome to the '''[http://soylentnews.org SoylentNews.org]''' Wiki.

We deliver community-sourced news and discussion. This is an [https://github.com/SoylentNews/slashcode open-source], grassroots effort powered by article submissions from our readers, volunteers, and our forked version of slashcode. We highlight stories on the web which are important to everyone - especially nerds. We also provide a soapbox for discussion moderated by the site's patrons, and allow anonymous discourse as there's no mandatory registration needed to comment.

We are mindful of community sentiment, and will not bend to overreaching corporate agenda. The goal is to be an excellent source for discussion and news about technology, art, science and politics.

We've incorporated as a Delaware Public Benefit Corporation (similar to a non-profit) as we feel our mission to provide a platform for news dissemination and relevant discussion is not only essential for mankind, but also a legal right (i.e. freedom of press, freedom of speech) in some places, and these are liberties which we aim to protect.

Though the site is young and there are [https://github.com/SoylentNews/slashcode/issues bugs], we are improving and adapting to satisfy the community's needs. We look forward to pushing the boundaries of web experience and are committed to involving the community on all major decisions.

==Get Involved==

This project is run entirely by the community and there are many different facets. Here are some of the many ways to participate:

*'''[http://soylentnews.org/submit.pl Submit a Story]'''
** Try joining the #rss-bot channel in [[SoylentNews:IRC|IRC]] for story ideas
*'''Volunteer'''
** Get in touch with the '''[[Development|Development Team]]''', especially if you know perl
** Reach out to one of the other '''[[TeamPages|Teams]]''' (we have openings for many skill sets)
** Contact the relevant person: '''[[WhosWho| Who's Who?]]'''
*Hop in to '''IRC:'''
** #soylent on irc.soylentnews.org/6697
** [http://irc.sylnt.us/?channels=#soylent Webchat]
** [[SoylentNews:IRC|IRC Wiki Page]]
*'''Bugs''' and Features:
** [https://github.com/SoylentNews/slashcode/issues/new Submit a bug or Feature Request]
** [[Suggestions|Add a Suggestion]] - larger projects to tackle for the future
*'''Tell Somebody''' A friend, a colleague, any major news source....
** Do what you can to [[Spreading the word|get the word out]]
** You could participate in [[The_Slashcott|The Slashcott]]

==Contacts==

A list of people working on this project:
===[[WhosWho| Who's Who?]]===

== Useful Links ==

*[[Submission guidelines]] - best practices for story submissions
*[[Story Style]] - a guide for editors on article formatting
*[[Development]] team page
**[https://github.com/SoylentNews/rehash Code Repo] - The Slashcode fork repository for this project on GitHub
** <strike>[[DevelopmentVMHowto]] - How to get our code setup in a VM</strike>
** [[SlashDocumentationIndex]]
*[[UserExperience]] team page
**[[Style]] - some of this info needs to be merged/moved/organized into/with [[UserExperience]]
**[[CssWork]]
* [[SystemAdministration|System Administration]]
*[[Finances]] - Breakdown of our proposed spending
*[[Licensing]] - ideas about which license to use for our slashcode fork
*[[Staff_Meetings|Staff Meeting Logs]]
*[[SoylentNews_PBC|SoylentNews PBC]]
*[[SoylentNews_Site_Policy|SoylentNews Policy]]

== Similar Projects ==
* [http://pipedot.org/ Pipedot] - A complete re-write that uses a modern codebase and sports a clean look
* Usenet newsgroup comp.misc - [https://groups.google.com/forum/#!forum/comp.misc on Google Groups], [http://squte.com/ on Squte], [news:comp.misc via newsreader application]
* [http://technocrat.net/ Technocrat] - (now defunt) News site presented by Bruce Perens

== Archive ==

[[Archive]] -- An archive of obsolete pages/discussions that occurred before launch

ApiDocs

2016-02-12T11:51:00Z

The Mighty Buzzard:

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. You may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl. Use the topiclist op to obtain a current list of topics. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* topiclist - returns an array of hashes containing data on every topic
** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

The element may also contain forward-slashes that correspond to array levels, allowing you to drill down into an array structure to retrieve a specific piece of data.
For example, to get the uid of the latest comment:
<pre>~api m=comment op=latest /0/uid</pre>

[[Category:Development]]

ApiDocs

2016-02-12T11:49:50Z

The Mighty Buzzard: /* story ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. You may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl. Use the topiclist op to obtain a current list of topics. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* topiclist - returns an array of hashes containing data on every topic (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

The element may also contain forward-slashes that correspond to array levels, allowing you to drill down into an array structure to retrieve a specific piece of data.
For example, to get the uid of the latest comment:
<pre>~api m=comment op=latest /0/uid</pre>

[[Category:Development]]

ApiDocs

2016-02-12T11:46:39Z

The Mighty Buzzard: /* story ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. You may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education On dev you may use the topiclist story op to obtain a current list of topics. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* topiclist - returns an array of hashes containing data on every topic (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

The element may also contain forward-slashes that correspond to array levels, allowing you to drill down into an array structure to retrieve a specific piece of data.
For example, to get the uid of the latest comment:
<pre>~api m=comment op=latest /0/uid</pre>

[[Category:Development]]

ApiDocs

2016-02-12T11:45:34Z

The Mighty Buzzard: /* story ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. You may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education On dev you may use the topiclist story op to obtain a current list of topics. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* topiclist - returns an array of hashes containing data on every topic (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

The element may also contain forward-slashes that correspond to array levels, allowing you to drill down into an array structure to retrieve a specific piece of data.
For example, to get the uid of the latest comment:
<pre>~api m=comment op=latest /0/uid</pre>

[[Category:Development]]

IRC

2015-10-05T11:37:52Z

The Mighty Buzzard: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:Crutchy|crutchy]] (dev/op) 
* [[User:chromas|chromas]] (admin) 
* [[User:juggs|juggs]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

ApiDocs

2015-08-20T12:15:58Z

The Mighty Buzzard: /* story ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. On dev you may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education On dev you may use the topiclist story op to obtain a current list of topics. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* topiclist - returns an array of hashes containing data on every topic (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

[[Category:Development]]

ApiDocs

2015-08-19T14:36:29Z

The Mighty Buzzard: /* story ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education An op needs to be added to be able to pull story topics for when they change. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

[[Category:Development]]

ApiDocs

2015-08-15T11:00:21Z

The Mighty Buzzard: /* auth ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

[[Category:Development]]

ApiDocs

2015-08-06T11:35:52Z

The Mighty Buzzard: out of date info

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://dev.soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

[[Category:Development]]

SN API ideas

2015-05-07T11:22:37Z

The Mighty Buzzard:

This page is dedicated to ideas for the SN API being developed by [[User:TheMightyBuzzard|TheMightyBuzzard]].

==Suggestions from IRC==
* actually, an api call that would be awesome would be an op where you supply cid and it spits out the sid ~ [[User:crutchy|crutchy]] @ 11:17, 7 October 2014 (UTC)
* supply cid and get the entire url ~ [[User:crutchy|crutchy]] @ 11:19, 7 October 2014 (UTC)
* redirect to the full url... or a redirect switch ~ [[User:crutchy|crutchy]] @ 11:20, 7 October 2014 (UTC)
* need app based access key authorization ~ [[User:TheMightyBuzzard|TheMightyBuzzard]] @ 11:32, 7 October 2014 (UTC)
** Eh, maybe at some future time. It's less abusable than the web interface already.
* wikimedia api uses normal login system but designates bots with a bot flag, which are permitted to use the api. maybe SN could do something similar ~ [[User:crutchy|crutchy]] @ 11:46, 7 October 2014 (UTC)
** Sounds problematic. I don't want to manually review who's a bot and who isn't.
* maybe make the basic api.pl with no parameters go to a doc page on how to use the api ~ [[User:crutchy|crutchy]] @ 20:53, 7 October 2014 (UTC)
** It links there, that's better behavior in an API since browsers aren't the target audience.
* <strike>a queue op to get the number of accepted articles waiting to be put out</strike> ~ [[User:crutchy|crutchy]] @ 12:31, 16 October 2014 (UTC)
** Count them yourself using the "pending" story op.
* get hash of any prod code file to check against personal dev copy ~ [[User:crutchy|crutchy]] @ 12:15, 20 October 2014 (UTC)
** Newp. Github already supplies this functionality and there are a few files on prod that do not mirror those on github.
* return username from uid and vice versa ~ [[User:crutchy|crutchy]] @ 12:01, 27 October 2014 (UTC) DONE
* gotta be at least one easter egg :) ~ [[User:crutchy|crutchy]] @ 13:00, 11 November 2014 (UTC)
* slashcode api library in php/perl/etc ~ [[User:crutchy|crutchy]] @ 13:06, 20 November 2014 (UTC)
* submission feed to an irc channel, and ability to meta-mod from irc ~ [[User:crutchy|crutchy]] @ 14:11, 20 November 2014 (UTC)

==Related pages==
[[ApiDocs]]

ApiDocs

2015-04-19T17:02:32Z

The Mighty Buzzard: /* auth ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work as the POST method is required.</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://dev.soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php

[[Category:Development]]

ApiDocs

2015-04-19T16:51:12Z

The Mighty Buzzard: /* auth ops */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work as the POST method is required.</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers. You should probably do this via POST for security reasons.
**<pre>https://dev.soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php

[[Category:Development]]

IRC

2015-03-03T20:00:22Z

The Mighty Buzzard: /* Bots */

IRC

2015-02-20T11:36:29Z

The Mighty Buzzard: added MrPlow

ApiDocs

2015-01-21T14:40:19Z

The Mighty Buzzard: adding errata

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work as the POST method is required.</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php

[[Category:Development]]

Development

2014-12-05T16:00:33Z

The Mighty Buzzard: Dev roster updated to reflect current status

[[TeamPages]] - parent, [[SystemAdministration]]

==Welcome==
We are currently looking for volunteers to help develop SoylentNews slashcode. Anyone willing is free to help, but '''we really need good perl devs'''. Slashcode is based heavily on perl and most pages have some type of perl code on them. We also seek non-perl devs, there is plenty of stuff that you can do without touching the code too much.

Our code is hosted on GitHub at https://github.com/SoylentNews/slashcode. Have a look and see how you can contribute. Bugs are now on [https://github.com/SoylentNews/slashcode/issues GitHub Bugs].

Volunteers should send an email to [mailto:dev@soylentnews.org dev@soylentnews.org] expressing your areas of interest and what your coding strengths are. Also you can hop onto [[SoylentNews:IRC]] and join the #dev channel. Come by and express your interest to paulej72, audioguy, or [[User:mrcoolbp|mrcoolbp]].

Currently we are undergoing a bit of a reorganization and we hope to have more information available here soon about our short term and long term goals for the code.

== Who we are ==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[Development|Dev Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| paulej72<ref name="paulej72_notes">Working on template and css issues on the site, main bug herder. - email:[mailto:paulej72@soylentnews.org paulej72@soylentnews.org] [[Paulej72WorkNotes]]</ref>
| Team Leader for Dev
| UTC-4 (EST/EDT)
|-
| Ncommander
| Currently on walkabout.
| UTC-5
|-
| martyb/bytram
| primary bug herder, Database (in training)
| UTC-4 (EST/EDT)
|-
| The Mighty Buzzard
| Code Monkey Extraordinaire
| UTC-6 (CST/CDT)
|}
<section end=whoarewe />

== Index of Development Pages and Resources ==

Note: Any sort of code posted onto the wiki can now be syntax highlighted using the <nowiki><syntaxhighlight></nowiki> tag. It will default to perl, but can be changed to other languages. For example <nowiki><syntaxhighlight lang="sql"></nowiki>. More documentation is at [[mediawikiwiki:Extension:SyntaxHighlight_GeSHi]].

* [[ImportantDevelopmentLinks]] - Place to put urls for the repositories, etc. (Use current page for now, this page not needed - YET)
* [[DevelopmentWorkCurrentlyInProgress]] - what we are working on at this moment
* [[CodingStyleForOurPerlChanges]] - Suggested style for perl code changes
* [[DevelopmentVMHowto]] - How to get your own Slash code up in a Virtual Machine using VirtualBox
* [[CssWork]] - pages for ongoing css work
* [[SlashDocumentationIndex]] - A single place to find Slash docs, one day it will be organized and accurate
* [[IncidentLog]] - Documentation of how incidents occurred and how they were mitigated
* [[GitUse]] - Tutorial/advice on how to use git
* [[Dev/Sys|To-do]] - A list of items in the pipeline collected from various places

== Work Notes ==

* [[AudioGuyWorkNotes]]
* [[Paulej72WorkNotes]]

== Resources ==

* [[SystemAdministration]] - See this section for actual server details and procedures
* GitHub https://github.com/SoylentNews/slashcode: Slashcode Repository and Issue Tracker
* Wiki: Documentation and work logs
**hosted on the svc linode
* IRC: real time chat for team communications
* Slashcott.org: temporary testing server in use until we get ones setup on Linode.
* Mailman Dev Mailing list: for non-real-time discussions that need a good paper trail.
* http://dev.mysql.com/doc/refman/5.5/en/index.html - Official docs for mysql we use
* https://perl.apache.org/start/index.html - modperl docs (We use version 1 with Apache 1.3)
* http://remote.demmers.org/~audioguy/manual/ - Apache 1.3 docs don't seem to be on the Apache site any more, here they are.
** http://remote.demmers.org/~audioguy/manual/misc/API.html but this is what is important to understand slash workings with mod perl.

== Slashcode Primer ==

Slashcode is a complex beast. Here is the listing of the repo:

<blockquote><code><pre>Bundle
Slash
bin
docs
httpd
plugins
sbin
sql
tagboxes
themes
utils
</pre></code></blockquote>

We really are only concerned with three of these directories: Slash, plugins, and themes. The first directory, Slash, is the home of the slash.pm module and its related code. The module, slash.pm, does all of the back end work of slashcode. It provides a set of APIs that are used to generate pages and manipulate the database. This is where the heavy perl coding is done. We definitely need help with this section in both expanding our knowledge and working with the code. (As I started on this from a css/html slant I do not have a good idea of what is here --pauej72)

The second main part of the system are the themes. In this case we have only one theme called slashcode. The theme is broken down into pieces the first is htdocs. htdocs is all of the static html files, perl files that directly start page generation events, the css files, images, and other static code. The second part of the theme is the templates. These templates are loaded into the database an are used by slash to layout the data from different sources and turn them into html files that apache can send to the user. Templates re a mixture of perl, slash coding, and html. Templates use slash calls to load other templates and usually each template leaves a breadcrumb in the final html with a start and end comment with the template's name and id. These breadcrumbs make it easy to find out which template file is generating the particular piece of html that you need to change.

Slashcode also has a plugin architecture that allows certain system to be bolted on to the main system. The main system is basically articles, comments and users. The pulgins add the admin interface, the messaging system, enhanced login, journals, and other things. The files for these plugging are in the plugins folder, not in the theme folder. The issue with plugins is that it contains both front end code such as templates, css and pl files, it also has perl modules that are loaded into the perl engine.

The rest of the directories are used for build and install purposes and probably will not need to be modified regularly.

This is a work in progress so please check back here for more.

== Development VM ==

Please see [[DevelopmentVMHowto]] for the full How To.

Additional notes: http://soylentnews.org/~crutchy/journal/114

==Integrated Development Environment==

'''Note''' This is a work in progress. Currently the Windows development environment seems mostly useless except for Syntax Highlighting and basic Code Navigation.

:Regardless of what IDE (''Integrated Development Environment'') you choose to go with, you're going to require a Perl interpreter (With a built-in Debugger) and optionally the PadWalker module, for variable inspection (Also used by built-in debugger).

=== Perl (Interpreter) ===
:Linux users generally already have a full Perl stack installed, so this resource is for Windows users. There's a number of different Perl interpreters available for Windows users. You can download ActivePerl for free below:

::* [http://www.activestate.com/activeperl/downloads www.activestate.com/activeperl/downloads]

=== PadWalker (Variable Inspection) ===
:* [http://perlmaven.com/padwalker perlmaven.com/padwalker]

=== IDEs ===
==== Eclipse ====
:Eclipse with the ''EPIC'' Plug-In provides a great Perl IDE for Windows users. After installing ActivePerl and the PadWalker module you will need to install a Java Runtime.

:'''Before you Begin:''' It's important to note that if you are running 64-bit Windows, you should choose the 64-bit JRE and pair it with a 64-bit Eclipse. They cannot be mis-matched (A 32-bit JRE with a 64-bit Eclipse or vice versa).

:'''Step 1)''':
:: Download Oracle's runtime for free below. You can choose the JRE (Runtime Environment) if you only want to do Perl/Slashcode development or the JDK (Development Kit) if you want to do Perl/Slashcode development and Java development in the future. Choosing the JRE will save you disk space:
:: [http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html Java Runtime Environment 7u55]
:: [http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html Java Developer Kit 7u55]

:'''Step 1.1)''':
:: After you have installed the JRE and restarted Windows, follow this guide from Oracle to setup the environment variables for Windows, including the PATH and CLASSPATH variables:
:: [http://docs.oracle.com/javase/tutorial/essential/environment/paths.html Environment Paths]

:'''Step 2)''':
:: Install the Eclipse IDE. You can download the latest release (Kepler) for free below:
:: [http://eclipse.org/downloads/packages/eclipse-standard-432/keplersr2 Eclipse Kepler]

:'''Step 3)''':
::Install the free ''"EPIC"'' plug-in for Eclipse. This is done from within Eclipse and is fairly straight forward. From within Eclipse, click the "Help" top strip-menu and choose the "Install New Software" option. You can also find detailed instructions below, however they may become out of date:
:: [http://www.epic-ide.org/download.php www.epic-ide.org/download.php] 
==== Geany ====
::As an alternative to Eclipse, you can try Geany. Geany isn't exactly a full IDE like Eclipse, however you can setup the file locations of Perl and get a pretty good workflow going. You can download Geany for free below:

::: [http://www.geany.org/Download/Releases www.geany.org/Download/Releases]

==Notes==
<references />

[[Category:Development]]
[[Category:Teams]]

ApiDocs

2014-11-22T13:38:34Z

The Mighty Buzzard: added pending op to story ops

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work as the POST method is required.</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

ApiDocs

2014-11-20T13:17:12Z

The Mighty Buzzard: lack of example

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work as the POST method is required.</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

ApiDocs

2014-11-20T13:11:37Z

The Mighty Buzzard: added reskey op to docs

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

ApiDocs

2014-11-20T13:11:00Z

The Mighty Buzzard: added reskey op to docs

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

ApiDocs

2014-11-19T17:55:34Z

The Mighty Buzzard: added post op to story ops

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* post - posts a comment. sid, postersubj, posttype, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

Suggestions

2014-11-16T13:31:30Z

The Mighty Buzzard: suggestion long since done

this page: http://sylnt.us/suggest

==Introduction==
This is a compilation of Suggestions from various users. Think of it like a "wish list". These differ from feature requests in that they are projects that may require a significant amount of time to implement. A system should be developed for selecting from one, and having the community vote on which to tackle.

Suggestions can currently be added via suggestions@soylentnews.org, or by typing "~suggest [your suggestion here]" in our IRC rooms (must be identified with NickServ). You can also just add them below (must be signed up / logged into wiki). You should check the [https://github.com/SoylentNews/slashcode/issues bug tracker on github] for bugs and feature requests, the [[TodoList]], or the respective team page before suggesting something to see if it is already being worked on.

Teams: feel free to draw from the following main and IRC suggestion lists and move to a todo list if you would like to tackle one (please remove from here if you do).

==Related pages==
* [[SNPodcast]]
* [[Spreading the word]]
* [[IRC#Bot_projects_.2F_task_ideas|IRC bot projects / task ideas]]
* [[SN API ideas]]
* [[ApiDocs|SlashCode API]]

==Suggestions: Main List==
*SoylentNewsRoundup or SNR (best stories, comments, journals, best of IRC)
*Articles Revisited: (by +5 commenters)
**research, correct, expand
**re-submit to topic "revisited.soylentnews.org"
**example: [[Articles:Watch_the_Watchers_with_Federal_Contracts_Database|Here]]
**Submit story for discussion/publicizing idea
*Add a "settled arguments" section to the wiki (example: the world population is out of control!)
*Add markdown support in SoylentNews ex: http://dillinger.io/
*SoylentNews alternate logo S/N (signal/noise) (also SN = Tin atomic symbol)
*Allow users to mod stories down.
*Allow up-modding of journal entries
*Host our own advertisements
**Keep them in separate areas (sidebars, boxes)
**Keep them (mostly) static
**Keep the off-site javascript requirements for them minimal
*Banner ads that people can use as forum signatures, etc. to spread the word about SoylentNews. See [[Banner ads|this archived forum thread]] for more information.
*Extend validity of mod points (new mod points only awarded once old mod points were used up, but once a user gets mod points he can use them for 3-4 days for topics he cares about instead of just using them up)
*add a field for 'submitters' comment' feature to the story submission process (see [https://soylentnews.org/~drussell/journal/543 this journal entry])

==Suggestions from IRC==
* for moderation, maybe allow anyone to moderate at any time as long as they are logged in and haven't contributed to the conversation, and only have a 'report spam' option as the only negative mod available ~ [[User:crutchy|crutchy]] @ 02:11, 13 September 2014 (UTC)
* put a link to the story queue on the front page instead of burying it under submit story :) ~ [[User:SpallsHurgenson|SpallsHurgenson]] @ 02:52, 17 September 2014 (UTC)
* cofee++ karma slashbox ~ [[User:crutchy|crutchy]] @ 07:22, 18 September 2014 (UTC)
* community-building: soylent could 'borrow' the nation states model (maybe with some modifications) and embed it into the SN community/karma/mod/relationship systems ~ [[User:crutchy|crutchy]] @ 08:03, 18 September 2014 (UTC)
* increase karma to maybe 10,000, have badge for number of comments posted, have badge for number of accepted stories, have badge for high levels of karma (bronze for 50+, silver for 250+ and gold for 500+ or something like that) ~ [[User:crutchy|crutchy]] @ 17:32, 18 September 2014 (UTC)
* Show users their own AC comments in their history ~ [[User:chromas|chromas]] @ 07:31, 22 September 2014 (UTC)
* if "comments are owned by whoever posted them" does that mean Soylent PBC has the right to publish them? just a comment on licensing ~ [[User:crutchy|crutchy]] @ 08:40, 22 September 2014 (UTC)
* TheMightyBuzzard make an irc bot for SN api suggestions :D ~ [[User:crutchy|crutchy]] @ 10:58, 22 September 2014 (UTC)
* 'xkcd of the week' slashbox. perhaps start with random xkcd and adjust if an xkcd has been mentioned in a comment/story/wiki edit/journal/irc chat/etc ~ [[User:crutchy|crutchy]] @ 00:44, 27 September 2014 (UTC)
* badges for no. of +5 comments (maybe inc separate funny, informative, etc). badge for no. of successful story submits ~ [[User:crutchy|crutchy]] @ 04:00, 28 September 2014 (UTC)
* need a way to submit SoylentNews bugs/issues without having to sign up to github, and also would be handy to have scripty check for similar existing issues and either automagically append or link to related issues ~ [[User:crutchy|crutchy]] @ 05:37, 28 September 2014 (UTC)
* write a scripty that extracts comments that don't include certain keywords (such as systemd) ~ [[User:crutchy|crutchy]] @ 09:58, 2 October 2014 (UTC)
* a compiled gui client application for SN, with integrated IRC, wiki, auto-login, feeds (based on keywords, username, topic, etc), treeview for comments, user relationship diagram, metadata collection for stats on users (such as no of comments, no of -1/0/1/2/3/4/5 comments, no of accepted submission...
* crutchy to build the above client ~ [[User:TheMightyBuzzard|TheMightyBuzzard]] @ 10:16, 2 October 2014 (UTC)
* community-building: free subscription to SN as prize for various activities, such as coding/bugsmashing comps, 50x+5 comments, etc (sorry not many ideas). not sure of legalities of prizes ~ [[User:crutchy|crutchy]] @ 19:00, 2 October 2014 (UTC)
* for SN client IRC module, a bar that shows the last line (or last few lines) said out of all channels that user is in ~ [[User:crutchy|crutchy]] @ 02:59, 5 October 2014 (UTC)
* we get moar meta moderation ~ [[User:crutchy|crutchy]] @ 11:09, 8 October 2014 (UTC)
* IRC op policy development ~ [[User:crutchy|crutchy]] @ 05:22, 19 October 2014 (UTC)
* incoming tweet feed for irc ~ [[User:crutchy|crutchy]] @ 21:33, 30 October 2014 (UTC)
* if #soylent becomes unruly could always make a server bot automatically redirect quotes containing keywords to a particular channel. then anyone that's interested can congregate there ~ [[User:crutchy|crutchy]] @ 04:13, 1 November 2014 (UTC)
* or if one person in particular becomes unruly, instead of banning them the server bot could be instructed to redirect all that nick's messages to some other channel with a message indicating where when first enabled ~ [[User:crutchy|crutchy]] @ 04:15, 1 November 2014 (UTC)
* a slashbox on SN showing the latest few privmsgs from #soylent ~ [[User:crutchy|crutchy]] @ 09:58, 3 November 2014 (UTC)
* irc polls published in a SN slashbox ~ [[User:crutchy|crutchy]] @ 23:44, 3 November 2014 (UTC)
* a user setting in SN that replaces every instance of a particular word with another word, such as "cloud" could be changed to "butt" (i know there's a firefox plugin for cloud to butt, but for any word in just SN) ~ [[User:crutchy|crutchy]] @ 09:07, 8 November 2014 (UTC)
* indication of logged in users ~ [[User:crutchy|crutchy]] @ 06:54, 14 November 2014 (UTC)
* slashbox with diego's relationship map (http://stats.sylnt.us/social/soylent/) shrunk down, with caption "who's chatting on irc?" ~ [[User:crutchy|crutchy]] @ 11:20, 16 November 2014 (UTC)

Hydrogen

2014-11-15T12:15:06Z

The Mighty Buzzard: added a br

{{#lst:SystemAdministration/Special:Includes|server_header}}
== Description ==
This server is currently down 
This server is a Linode 4G server running Ubuntu Linux 14.04 which functions as the one of main front end server, the web server can be reached [https://soylentnews.org/ here].

== Services running on this host ==
Any services that is prepended with an exclamation mark is not yet being monitored by our Icinga instance.
<section begin=services />
* ![[Soylent-www|Varnish]]
* ![[Soylent-www|Memcache]]
* ![[Soylent-www|Gluster]]
* ![[Soylent-www|Apache 1.3/httpd]]
* OpenSSH
* ntpd
<section end=services />

[[Category:SystemAdministration/Servers]]

Hydrogen

2014-11-15T12:14:20Z

The Mighty Buzzard: needed to be noted that the server was not in use

{{#lst:SystemAdministration/Special:Includes|server_header}}
== Description ==
This server is currently down
This server is a Linode 4G server running Ubuntu Linux 14.04 which functions as the one of main front end server, the web server can be reached [https://soylentnews.org/ here].

== Services running on this host ==
Any services that is prepended with an exclamation mark is not yet being monitored by our Icinga instance.
<section begin=services />
* ![[Soylent-www|Varnish]]
* ![[Soylent-www|Memcache]]
* ![[Soylent-www|Gluster]]
* ![[Soylent-www|Apache 1.3/httpd]]
* OpenSSH
* ntpd
<section end=services />

[[Category:SystemAdministration/Servers]]

SystemAdministration/Services

2014-11-15T12:12:46Z

The Mighty Buzzard: Added Fluorine

= A list of all services on li649-22 machines. =

Any services that is prepended with an exclamation mark is not yet being monitored by our Icinga instance.

If a service is missing from a node, please edit the node's page directly, this page only transcludes sections from the node pages.

== [[SystemAdministration/Server/Boron|Boron]] ==

{{#lst:SystemAdministration/Server/Boron|services}}
== [[SystemAdministration/Server/Lithium|Lithium]] ==

{{#lst:SystemAdministration/Server/Lithium|services}}
== [[SystemAdministration/Server/Carbon|Carbon]] ==

{{#lst:SystemAdministration/Server/Carbon|services}}
== [[SystemAdministration/Server/Hydrogen|Hydrogen]] ==

{{#lst:SystemAdministration/Server/Hydrogen|services}}
== [[SystemAdministration/Server/Fluorine|Fluorine]] ==

{{#lst:SystemAdministration/Server/Fluorine|services}}
== [[SystemAdministration/Server/Helium|Helium]] ==

{{#lst:SystemAdministration/Server/Helium|services}}
== [[SystemAdministration/Server/Oxygen|Oxygen]] ==

{{#lst:SystemAdministration/Server/Oxygen|services}}
== [[SystemAdministration/Server/Beryllium|Beryllium]] ==

{{#lst:SystemAdministration/Server/Beryllium|services}}

ApiDocs

2014-11-12T21:11:52Z

The Mighty Buzzard: typos

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* post - posts a comment. sid, postersubj, posttype, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

ApiDocs

2014-11-12T18:44:38Z

The Mighty Buzzard: added post to comment ops

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is by no means live and it's possible it may never become that way. In the event that it does though, I want it documented so people can actually start building against it right off.

As of now the API is read only and does not feature authorization or anything that should require the code to auth.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to preform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* post - posts a comment. sid, postersubj, posttype, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code
** <pre>http://tmbvm.ddns.net/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>http://tmbvm.ddns.net/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>http://tmbvm.ddns.net/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===

[[Category:Development]]

ApiDocs

2014-11-11T12:49:21Z

The Mighty Buzzard: closed pre tags

ApiDocs

2014-11-11T12:48:38Z

The Mighty Buzzard: added journal ops

SN API ideas

2014-11-08T11:54:28Z

The Mighty Buzzard:

ApiDocs

2014-11-07T15:15:32Z

The Mighty Buzzard: minor edit

ApiDocs

2014-11-07T15:08:48Z

The Mighty Buzzard: added comment ops

ApiDocs

2014-11-07T14:51:08Z

The Mighty Buzzard: added story ops

ApiDocs

2014-11-07T14:30:14Z

The Mighty Buzzard:

ApiDocs

2014-11-07T14:28:24Z

The Mighty Buzzard: Initial creation

Historic:Finances/Archive

2014-09-15T19:43:18Z

The Mighty Buzzard: Replaced content with "Rewrite coming very soon. This page was extremely dated and has been archived here."

Rewrite coming very soon. This page was extremely dated and has been archived [[FinancesARCHIVED|here]].

Development

2014-07-09T04:21:36Z

The Mighty Buzzard: /* Who we are */

[[TeamPages]] - parent, [[SystemAdministration]]

==Welcome==
We are currently looking for volunteers to help develop SoylentNews slashcode. Anyone willing is free to help, but '''we really need good perl devs'''. Slashcode is based heavily on perl and most pages have some type of perl code on them. We also seek non-perl devs, there is plenty of stuff that you can do without touching the code too much.

Our code is hosted on GitHub at https://github.com/SoylentNews/slashcode. Have a look and see how you can contribute. Bugs are now on [https://github.com/SoylentNews/slashcode/issues GitHub Bugs].

Volunteers should send an email to [mailto:dev@soylentnews.org dev@soylentnews.org] expressing your areas of interest and what your coding strengths are. Also you can hop onto [[SoylentNews:IRC]] and join the #dev channel. Come by and express your interest to paulej72, audioguy, or mrcoolbp.

Currently we are undergoing a bit of a reorganization and we hope to have more information available here soon about our short term and long term goals for the code.

== Who we are ==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[Development|Dev Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| paulej72<ref name="paulej72_notes">Working on template and css issues on the site, main bug herder. - email:[mailto:paulej72@soylentnews.org paulej72@soylentnews.org] [[Paulej72WorkNotes]]</ref>
| Team Leader for Dev
| UTC-4 (EST/EDT)
|-
| Ncommander
| The real head of Dev, but due to time constrains of being the head of SN, only a member.
| UTC-5
|-
| audioguy<ref name="audioguy_notes">See [[AudioGuyWorkNotes]] for current todo and working notes - documentation of system and cleanup of css to get things into a ste that new templates and Themes can be made.</ref>
| right hand man to paulej72 and second in command for Dev.
| UTC-8 (PST)
|-
| FatPhil
| perl/mysql odd-jobber, some ubuntu/sys knowledge too
| UTC+2
|-
| martyb/bytram
| secondary bug herder, Database (in training)
| UTC-4 (EST/EDT)
|-
| The Mighty Buzzard
| Code Monkey Private First Class
| UTC-6 (CST/CDT)
|}
<section end=whoarewe />

== Index of Development Pages and Resources ==

Note: Any sort of code posted onto the wiki can now be syntax highlighted using the <nowiki><syntaxhighlight></nowiki> tag. It will default to perl, but can be changed to other languages. For example <nowiki><syntaxhighlight lang="sql"></nowiki>. More documentation is at [[mediawikiwiki:Extension:SyntaxHighlight_GeSHi]].

* [[ImportantDevelopmentLinks]] - Place to put urls for the repositories, etc. (Use current page for now, this page not needed - YET)
* [[DevelopmentWorkCurrentlyInProgress]] - what we are working on at this moment
* [[CodingStyleForOurPerlChanges]] - Suggested style for perl code changes
* [[DevelopmentVMHowto]] - How to get your own Slash code up in a Virtual Machine using VirtualBox
* [[CssWork]] - pages for ongoing css work
* [[SlashDocumentationIndex]] - A single place to find Slash docs, one day it will be organized and accurate
* [[IncidentLog]] - Documentation of how incidents occurred and how they were mitigated
* [[GitUse]] - Tutorial/advice on how to use git
* [[Dev/Sys|To-do]] - A list of items in the pipeline collected from various places

== Work Notes ==

* [[AudioGuyWorkNotes]]
* [[Paulej72WorkNotes]]

== Resources ==

* [[SystemAdministration]] - See this section for actual server details and procedures
* GitHub https://github.com/SoylentNews/slashcode: Slashcode Repository and Issue Tracker
* Wiki: Documentation and work logs
**hosted on the svc linode
* IRC: real time chat for team communications
* Slashcott.org: temporary testing server in use until we get ones setup on Linode.
* Mailman Dev Mailing list: for non-real-time discussions that need a good paper trail.
* http://dev.mysql.com/doc/refman/5.5/en/index.html - Official docs for mysql we use
* https://perl.apache.org/start/index.html - modperl docs (We use version 1 with Apache 1.3)
* http://remote.demmers.org/~audioguy/manual/ - Apache 1.3 docs don't seem to be on the Apache site any more, here they are.
** http://remote.demmers.org/~audioguy/manual/misc/API.html but this is what is important to understand slash workings with mod perl.

== Slashcode Primer ==

Slashcode is a complex beast. Here is the listing of the repo:

<blockquote><code><pre>Bundle
Slash
bin
docs
httpd
plugins
sbin
sql
tagboxes
themes
utils
</pre></code></blockquote>

We really are only concerned with three of these directories: Slash, plugins, and themes. The first directory, Slash, is the home of the slash.pm module and its related code. The module, slash.pm, does all of the back end work of slashcode. It provides a set of APIs that are used to generate pages and manipulate the database. This is where the heavy perl coding is done. We definitely need help with this section in both expanding our knowledge and working with the code. (As I started on this from a css/html slant I do not have a good idea of what is here --pauej72)

The second main part of the system are the themes. In this case we have only one theme called slashcode. The theme is broken down into pieces the first is htdocs. htdocs is all of the static html files, perl files that directly start page generation events, the css files, images, and other static code. The second part of the theme is the templates. These templates are loaded into the database an are used by slash to layout the data from different sources and turn them into html files that apache can send to the user. Templates re a mixture of perl, slash coding, and html. Templates use slash calls to load other templates and usually each template leaves a breadcrumb in the final html with a start and end comment with the template's name and id. These breadcrumbs make it easy to find out which template file is generating the particular piece of html that you need to change.

Slashcode also has a plugin architecture that allows certain system to be bolted on to the main system. The main system is basically articles, comments and users. The pulgins add the admin interface, the messaging system, enhanced login, journals, and other things. The files for these plugging are in the plugins folder, not in the theme folder. The issue with plugins is that it contains both front end code such as templates, css and pl files, it also has perl modules that are loaded into the perl engine.

The rest of the directories are used for build and install purposes and probably will not need to be modified regularly.

This is a work in progress so please check back here for more.

== Development VM ==

Please see [[DevelopmentVMHowto]] for the full How To.

Additional notes: http://soylentnews.org/~crutchy/journal/114

==Integrated Development Environment==

'''Note''' This is a work in progress. Currently the Windows development environment seems mostly useless except for Syntax Highlighting and basic Code Navigation.

:Regardless of what IDE (''Integrated Development Environment'') you choose to go with, you're going to require a Perl interpreter (With a built-in Debugger) and optionally the PadWalker module, for variable inspection (Also used by built-in debugger).

=== Perl (Interpreter) ===
:Linux users generally already have a full Perl stack installed, so this resource is for Windows users. There's a number of different Perl interpreters available for Windows users. You can download ActivePerl for free below:

::* [http://www.activestate.com/activeperl/downloads www.activestate.com/activeperl/downloads]

=== PadWalker (Variable Inspection) ===
:* [http://perlmaven.com/padwalker perlmaven.com/padwalker]

=== IDEs ===
==== Eclipse ====
:Eclipse with the ''EPIC'' Plug-In provides a great Perl IDE for Windows users. After installing ActivePerl and the PadWalker module you will need to install a Java Runtime.

:'''Before you Begin:''' It's important to note that if you are running 64-bit Windows, you should choose the 64-bit JRE and pair it with a 64-bit Eclipse. They cannot be mis-matched (A 32-bit JRE with a 64-bit Eclipse or vice versa).

:'''Step 1)''':
:: Download Oracle's runtime for free below. You can choose the JRE (Runtime Environment) if you only want to do Perl/Slashcode development or the JDK (Development Kit) if you want to do Perl/Slashcode development and Java development in the future. Choosing the JRE will save you disk space:
:: [http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html Java Runtime Environment 7u55]
:: [http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html Java Developer Kit 7u55]

:'''Step 1.1)''':
:: After you have installed the JRE and restarted Windows, follow this guide from Oracle to setup the environment variables for Windows, including the PATH and CLASSPATH variables:
:: [http://docs.oracle.com/javase/tutorial/essential/environment/paths.html Environment Paths]

:'''Step 2)''':
:: Install the Eclipse IDE. You can download the latest release (Kepler) for free below:
:: [http://eclipse.org/downloads/packages/eclipse-standard-432/keplersr2 Eclipse Kepler]

:'''Step 3)''':
::Install the free ''"EPIC"'' plug-in for Eclipse. This is done from within Eclipse and is fairly straight forward. From within Eclipse, click the "Help" top strip-menu and choose the "Install New Software" option. You can also find detailed instructions below, however they may become out of date:
:: [http://www.epic-ide.org/download.php www.epic-ide.org/download.php] 
==== Geany ====
::As an alternative to Eclipse, you can try Geany. Geany isn't exactly a full IDE like Eclipse, however you can setup the file locations of Perl and get a pretty good workflow going. You can download Geany for free below:

::: [http://www.geany.org/Download/Releases www.geany.org/Download/Releases]

==Notes==
<references />

[[Category:Development]]
[[Category:Teams]]