Instruction Manual
- What is Peaches 'n' Stink?
- Posts
- Comments
- Inbox
- Formatting
- Groups
- Private Groups
- Action Groups
- Following
- Settings
- Editing
- Open Source
- Privacy Policy
- How to Contact Us
- API
What is Peaches 'n' Stink?
Peaches 'n' Stink is a privacy-oriented, non-engagement, self-moderated, distributed link aggregation internet forum. Users can write posts and nested comments. You can only see posts and comments from those users that you follow. It does not include any admin tools or traditional moderation tools.
Posts
Posts are the main way to submit content. All topics are allowed (unless illegal). You must be logged in to create a post. Use new post in the site navigation to go to the create post form. Posts have a title, link, content and a group. Only title is required. The home page displays all posts from all users.
There are four ways to sort posts. These sorting options are available at the top of the home page, at the top of group pages (e.g. r/meta), and when using the /posts API call. Here is a description of each sorting option:
- Newest: This is a reverse chronological ordering based on the post time, and this is also the default.
- Oldest: This is a chronological ordering based on the post time.
- Comments: This ordering is based on the number of comments a post has. The posts with the most comments will appear first.
- Last Comment: This ordering is based on the last comment time for the post. The post with the most recent comment will appear first.
Comments
You can write comments on posts and other comments. You must be logged in to create a comment. If you're logged in, then there's a comment form at the top of each post and comment page, and there are "reply" links below each comment.
Inbox
The inbox shows all comments that have been made directly on your posts and comments.
Formatting
These are the available formatting rules for posts and comments:
- All newlines are automatically preserved.
- You can use ```pre and ``` to preserve spaces/whitespace for a group of lines. ```pre must come first on its own line and ``` must come last on its own line. All whitespace in between will be preserved. This is intended for writing computer programming source code.
- You can create hyperlinks by putting brackets before the URL. For example like this: []https://www.mysite.com. If you want to use custom text put it in the brackets, e.g.: [green]http://colors.com/green.
Groups
When you create a post you can add it to a group (this is optional). Each group has its own page with all of its posts. For example, the meta group. Groups display to the right of the post time for each post; click these links to go to the group's page!
Private Groups
By default, all posts and comments are public. But with private groups, you can use Peaches 'n' Stink privately with your friends, family and peers. Private groups use the same mechanism as "normal" groups and can be mixed with them.
In order to create a private group you must log in and go to groups settings. On this page you can create new private groups, see all your created private groups, and see all the other private groups you're a part of. For each of your created private groups, there is a settings link where you can add and remove users.
All private groups must start with "p-", for example, "p-cheese". When you first create a private group it must be empty of posts. Private groups attached to posts cannot be edited like normal groups. It is possible to use multiple private groups on the same post. Posts and comments from private groups will properly show and hide throughout the entire site. For example, posts from your private groups will appear on the home page. Posts and comments for private groups are currently stored in the database the same way as normal groups - in other words, private groups content is not currently encrypted or anything like that.
Action Groups
There are special groups called action groups. When you use one of these groups on your post, it will trigger a specific action outside of your post. Any data that the action requires is placed in the post content. Here are the currently available actions:
- New Node: This action will add a new network node to the network page. It simply makes the current instance of Peaches 'n' Stink aware of another instance of Peaches 'n' Stink. In order to trigger this action you must use the "new-node" group on a post. And you must put only the root URL of the new Peaches 'n' Stink instance in the post content.
Following
On the right side of usernames there is a plus or minus button. You can follow the respective user with the plus button. The minus button unfollows. You can only see posts and comments that have been posted by users that you're following. You can manage who you're following by using following in the site navigation (if you're logged in).
Settings
You can access the settings in the site navigation. You can use the settings even if you're logged out. If you are logged in, then there are two additional settings pages for username and groups. Instructions for groups settings can be found in the private groups section of this instruction manual. The available settings are:
- Time Zone: this will adjust the time that is displayed for each post and comment.
- Following List: this determines which list of users you will use. You can use your own list (the users you follow) or another user's list. You can only see posts and comments made by users on the selected list.
- Site Width: you can use this setting to set the site width. Valid values are 500-1000 or blank. If you use a number between 500-1000 then that will be the site width in pixels and the site will be horizontally centered. If this setting is left blank then the site will take up the entire browser width. The default value is 600.
- View Mode: this affects how posts and comments display that are from unfollowed users; "locked" completely hides these posts and comments, while "discover" will show these posts and comments but only with the username and time. There is a shortcut to toggle this option at the top of every list of posts and comments.
- Replying to Comments: this affects how the comment reply links work. If you select "basic" then comment reply links will take you to a comment form on a different page. If you select "quick" then comment reply links will immediately open a comment form under the reply link. The default is "quick". This is only for logged in users.
- Username: You can use this setting to change your username. This is only for logged in users. This setting has its own page.
Editing
You can edit your posts and comments anytime you want. For posts, the edit link is to the right of the comment count. And for comments the edit link is to the right of the permalink and reply links. Currently there is no delete post or delete comment - but you can delete content via editing.
Open Source
The source code for Peaches 'n' Stink is available on GitHub under the MIT license.
Privacy Policy
Please see our privacy policy here.
How to Contact Us
There are a couple contact methods listed on the contact us page.
API
We have an API, please see the API documentation here.