Getting Started With Noostr

Noostr is a social news platform, similar in function to sites like Reddit and Hacker News. Using the Noostr platform, you can create your own social news site in less than 5 minutes (possibly even under 2 minutes).

Contents

Requirements

Noostr requires the following:

If your host does not meet the above requirements, Noostr probably won't work for you.

Installation

Before you begin, make sure you have the following things: a way to access your server (via shell or FTP), an FTP client, a text editor (like Notepad, gEdit or Code), and a web browser of your choice.

Extended documentation will be coming later in the development process, but for now, here are the steps to install Noostr on your host:

That's it! Noostr has been installed and is ready to go!

Upgrading

If you are upgrading Noostr to a new version, it should notice and take you to the upgrade page automatically. If it doesn't, run the Noostr upgrade script by accessing /install/ in your browser. For example, http://example.com/install/

First Steps

Definitely change your password. Just click your name at the top-right corner of the default theme and set yourself up.

The account you created during installation is the only administrative account in the system. The administration section is found at /admin/ (for example, http://example.com/admin/). Head there and click the "Settings" tab to start customizing your Noostr site.

Themeing

Noostr follows in the footsteps of WordPress more than anything else as far as themes go.

Themes in Noostr are just PHP files loaded by the engine in order to display content to the user. They are located in the "/style/" folder by default.

The default theme in Noostr is special - if you are using a custom theme and a requested file cannot be found, the equivalent one from the default theme will be used instead. As such, a custom theme can be as simple as a new CSS file that simply re-skins the default theme.

More advanced documentation on themes will be available soon. For now, it is best not to modify the default theme, since it will be overwritten during upgrades. If you want to make a custom theme or make modifications to the default theme, just copy it's files to a new theme folder and edit the "style.css" file to reflect the new name of the theme. In order to use a custom theme with Noostr v0.6, you'll need to modify a record in the "ns_settings_site" table in your database. Find the record where "group" is "general" and "variable" is "style" - then just change the "value" field to the name of the folder where your theme is located (for example, "default" refers to "/style/default/").