mirrors: picosite.kaizushigdv5mrnz.onion
Home License Documentation Contribute Credits Donate
About Contact Products
| 6:59:14 20/01/2020 | First picosite vendor store |
DocumentationIn the picosite files there is a README document that is updated with the project. It should be consistent with the latest version in the master branch.
=== PICOSITE README ===
=== Introduction ===
This is picosite, it is a CMS that relies on one uploading files or using
and editor with SSH. It basically searches for files of specific names and
protects against injection by having these names hardcoded, and there is
a regexp which only allows files to have certain characters.
I kept updating it without any version control, so the versions older than
what is here are not-existent.
=== Features ===
* Rainbow Dash, your best friend in the corner. Rainbow Dash can display on
all pages and this is powerful. We love Rainbow Dash because we are
lesbians who love My Little Pony. Girls only!
* Compatibility, this software is written in a way that the way you configure
it one will always have full backward compatability. This is
considered at every step of development. There are no depreciated
features for this software. However some new features will make old
ones redundant sometimes. However, the old features stay.
* Picocalls, there are only a half dozen of them so far but they put power
in the pages you create. Features like Pages, Include, Blogs, and
Subpages, Guides, and Price Lists can be called with a picocall and
if you have created the files and folders they depend on, they will
work and build your site. You can't really call it 'programming'
and it is very easy.
* Pages, as such pages just sit in the same file as page.php which is the
brains of picosite.
* Intentional Redundant Code, at the bottom of page.php is the same code as
template.php but if you have the template it is ignored. This allows
you to go without it and do things simple. If you want your own nice
theme you should make a template.
* A static menu, a file called menulayout.txt can put Pages in a top menu
where the order is preserved as what you put in menulist.txt
* A automatic menu, which is every page except those in the static menu.
They are sorted alphabetically.
* Include, there is a picocall to include some other file in a page.
I find this useful for doing a canary or providing GPG keys.
* Translations, these also sit in the directory with page.php and there is
a text file for a list of languages. You can also have translations
for guides, blogs, subpages, and soon prices.
* Blogs, a directory called 'blogs' can be created and files placed within
for adding to the blog. It uses the modification time of the file
to know the date of a blog. There is a picocall to put it in Pages
which includes a list of blogs, and also it displays a blog when
a blog that exists is specified by name in the GET value 'b'.
* Latest blog post, in the header of every page unless you are viewing
a blog post or the listing of blogs - is the latest blog post.
* Subpages, these are replacing guides and are similar code. They allow one
to make a picocall that on a page will show a list of other pages
in a directory you create. The picocall names the directory and
you can then put pages in it. They render like all other pages on
the site.
* Guides, guides can exist in a folder called 'guides' and they support
translations. Much like blogs there is a picocode for the Pages
which shows a list of guides or if GET value 'g' is passed an
actual guide if the file exists. [Now this is Subpages]
* Pricing system, if you write a cron job to get Bitcoin and Monero
prices from somewhere and put them in files 'xmrprice' and
'btcprice' you can display a list of prices for various
products. There is a picocode for Pages which makes a list of
prices to be displayed. Products are listed in the file
itemlist.txt with prices in the currency that your cron
job fetches. The price list is displayed in the same order
as the item list.
* Security, having had trouble with vandals of PHP software and some
malware, I wrote this so nothing could go wrong. As such the
site has no editor, there is no code which can alter the site
in picosite One has to log in with SSH and create files.
=== Coming Soon ===
* BBCode, you will soon have an alternate parser however it will render
HTML in pages unusable. It will be instantiated by a picocall
that can be placed anywhere in a page. With this picosite will
let you use BBCode to write pages.
* Stability, this documentation may make promises that are not kept yet,
but for every bug there is a workaround. The problems with this
software however are simple. They also have no impact on security.
* Efficieny, this software has some redundant code and almost identical
methods. These will be broken up into more methods.
=== Introduction ===
[[[Skip to line 185 to jump to how to use your picosite]]]
= Credits and How it Began =
- Kaizu -
I Kaizu Shibata developed this starting in February 2019 as a simple
website that got more complicated. Most development has been done rec-
ently and it is undergoing a big change. It was a hodgepodge and had
much redundant code. Now it is becoming more principled and streamlined
though it now involves more code.
The picosite software is developed to run my deep web hosting buisness.
It is call Kaizushi's Little Onion Server which runs Hardened Gentoo,
and uses SELinux. Yet despite the best of mitigations and backend secu-
rity, my interactive PHP frontends would get owned.
I thought of PHP signing every page on my wiki, but then nobody would
spend time checking signatures. One night I was looking for inspiration
in general browsing Volatile Git (git.volatile.bz) and found a guys st-
atic site generator. I realised I could learn PHP and write a simple
site to power my business.
At first this site just had the Page feature and was just over 150 lin-
es of code. I never kept reveisions and just experimented on code and I
had only known PHP a couple of months. As I added features I had to
find ways to manage them.
So the site grew and became bloated with some redundant code blocks.
And then I wanted more than just 'guides' as I plan to write fiction,
and maybe even have an area for music I love from hooktube. So I wanted
to do the Subpages feature. I realised when I thought of it that it cou
ld subsume a lot of features.
I distributed the software to another user who wanted a hack proof
blog, and he edited it a bit. He sent me his code and I made a diff to
see what he did. He made a bunch of things optional simply by them ch-
ecking if files related to the features exist, and using 'return' to
get out of methods quick. This gave me more ideas to fix the site.
So I got Git and made a local repo and Github. I decided this tool wou-
ld be good. I make small changes in the experimental branch 'fiddling'
and push them to 'master' when they work. Big new features and where I
make a new feature I give it a name. So far we have 'subpage' which is
done, which was then moved to 'testing' so I could fix it up and get st
uff I broke making it work.
The result is software you can use to have a secure site with price es-
imates, a blog to post news about your shop, pages to describe your se-
rvices, a large amount of organised pages, subpages to have listings of
guides and all kinds of other content. It is easy to start using and
get a site up using just some of the features and enable them slowly
and not waste resources on things you don't need.
You should find I am receptive to ideas about how to improve to the pr-
oject. I am an avid fan of Ayn Rand and love the ideas of businessmen
on the dark web. As such if you find yourself using this for its price
list you will will find I might add more features you suggest. As long
as they do not go against principle features, the the backward compata-
bility.
I am also interested in more developers. I am tempted to add a picocode
which drags in PHP. This could allow for very powerful extensions to the
system. I am also interested in core changes as long as they maintain
the backward compatability and read only nature of the site. I would
love a general code review and optimization. I have no ideas on a good
way to cache files in memory as it opens a looks through many.
Anyway, that is my project and my dream with it. My next steps in deve-
lopment are to make it support BBCode and some whole new picocode that
does markup for in page prices and links to pages and subpages. This is
the stuff that is easy but will take time. I have found a way by using
an empty string that is filled with HTTP GET variables, that I can rep-
lace much code and if statements to shrink the code.
As Cyrus the Great would say: Enjoy the software!
= Licence =
This software is covered by the MIT licence. As such it has no warranty
and one is free to use the code for any purpose. For more details you
should see LICENSE which is shipped with the source code.
= Requirements for Setup =
* This software requires a webserver with PHP 7.3 but it may work on ol-
der PHP installations. As such it is untested on earlier versions of
PHP. It is currently tested on Kaizushi's Little Onion Server but not
entirely.
* It should not require anything but your basic PHP without extensions.
This itself is not tested.
* Things that require extensions are usually optional.
* It can use a lot of open files if you get a DDOS attack. This may be
solved with a global cache of some kind. For now the script has a li-
mitation to reduce software complexity.
* Your site can be read only for the PHP script, but it has no code wh-
ich can be used to alter your system in any way.
= Install the script =
To install picosite at its bare minimum you copy page.php and start re-
ading. With this you are required to make a main.page for which there
are directions below. You can make other pages and gradually enable fe-
atures on the site.
If you copy the whole project completely you may wish to stop them rea-
ding README.txt, REFERENCE.txt, and even the README.md as these can up-
date with new features and be used to version you. If you think that is
hard they can use copy-paste and Google to do it well.
One should be using HTTPS, Tor, I2P, or some other kind of encryption
for serving the site. Without it despite its read only nature it would
be vulnerable to man-in-the-middle attacks. It was originally concieved
for being an Onion service. It very happily runs on many domains at
once and consistently uses relative paths.
One may wish to move the getprices.php script out of the web directory
and into their home directory. The path in the file on most SELinux
systems will have to write into a folder called data in the webdir.
There are globals in the file to set your base currency and your path
to the data directory, where it places two flatfiles containing a
price. It gets the data with JSON, this script uses network services
but can made highly secure with the right system
One may wish if they do not have advanced hosting and can't use cron
anyway to delete getprices.php. They could instead upload files to set
the price manually for their site. One could even have a script with a
SFTP or FTP and upload the price from another box to basic hosting.
= Set the Site Name and Logo =
There are some config settings at the top of page.php which control
the site. One is for the site name and you can also set others. You
might also want to change the logo graphic.
There is also a image of my mascot Rainbow Dash in the corner, when you
get to the end it tells you how to change the CSS. It is very easy to
remove and you could just delete the file. However then your webserver
will get a 404 for every request.
= Change the Main Page =
To change your first page edit a file called main.page and wipe the
one which came with picosite. This page is the 'home' of your website.
This page is required and you will get a 404 if you delete it. Set the
title of the page wish the picocode below:
This is the first picocode you learn and The Page Title can be anything
you like. This is required on all Pages you create. In future the page
title will be able to handle HTML. For now the HTML works somewhere but
in the title bar it would display. The trick will be to filter it out
so one can put emphasis on headings and menu items.
After this step that is required, the parts that come are optional and
you don't use them. The main page uses the same syntax as any other
page.
Pages on picosite can contain HTML but cannot use PHP. A coming feature
is being able to use BBCode to make it user friendly.
= Create more pages =
You can optionally create more than one page. To do this you simply
create a file ending in .page and its name only allows certin
characters. These are lower case and upper case letters, numbers,
and a dash (-). This is to prevent exploits and exfiltration of files
using injection exploits.
The filename you give a page must end in .page like the main page and
I call it the nodename. This is a machine name used throughout the
picosite system. If the machine name was 'burgers' then the page
would be named as such:
burgers.page
Don't forget when you create a page to make a title for it as this is
very much required. This uses the title picocode, and once again there
is no space at the start like this document has.
Most the features of picosite are added to pages with a picocode. You
will be learning the rest as you read.
= Include a file into a page =
Then you might want to include something in a page, as such you can use
this picocode:
|