IPSD

IPSD(Inter Planet Site Watchdog) is a tool to work with IPSC and create static html site automatically.

Background

IPFS (Inter Planet File System IPFS) is a peer-to-peer hyperlink protocol which is used to publish content. We can publish a web site on IPFS as we publish a site on http.

But as IPFS is an p2p system, file published on IPFS cannot be changed, if we changed a file and publish to IPFS again, it is a completely new file from the old one. Changing files of a IPFS file is not encouraged. So generally sites that are built on ASP.NET Java PHP which have a lot of scripts are not the best option when you want to publish a site to IPFS. Static website based on HTML and CSS is the best option.

IPSC is the tool to create static html site that you can publish to IPFS.

IPSD work with IPSC to create site automatically.

Install

Download the release for your platform from Releases, unzip it.

Build

If you can not find a release for your platform, build it from source code as follows:

1. Install go

2. Install git

   	Download and install
   		https://git-scm.com/download
   	OR
   		sudo apt-get install git	
   

3. Install mingw(Windows)

4. Install Liteide (https://github.com/visualfc/liteide)

   ​ *Windows/Linux/MacOSX just download and install

   ​ *Raspbian

   ​ Download source (qt4 Linux 64)code and compile as follows

       sudo apt-get update
       sudo apt-get upgrade
       sudo apt-get install git
       git clone https://github.com/visualfc/liteide.git
       sudo apt-get install qt4-dev-tools libqt4-dev libqtcore4 libqtgui4 libqtwebkit-dev g++
       cd liteide/build
       ./update_pkg.sh
       export QTDIR=/usr
       ./build_linux.sh
       cd ~/liteide/liteidex
       ./linux_deploy.sh
       cd ~/liteide/liteidex/liteide/bin 
       ./liteide

5. Open ipsd with liteide

6. Select the platform you needed, modify current environment according to step 1 and 3 Modify GOROOT and PATH

7. Compile->Build

Commands

NOTE: Run this tool with Administrator Permission

• New Monitor

ipsd -Command NewMonitor -SiteFolder -SiteTitle  -MonitorFolder

Create a new monitor, connect a originail source folder to a ipsc site project folder

Example:

ipsd -Command NewMonitor -SiteFolder "F:\TestSite" -SiteTitle "Test Site" -MonitorFolder "F:\WatchdogSpace"

• Run Monitor

ipsd -Command RunMonitor -MonitorFolder -IndexPageSize

Run the monitor defined in MonitorFolder , if there are any change in the monitor folder (add delete or update), will update the changes to ispc and then compile site with IndexPageSize

IndexPageSize (for index page and more page of site, for more information, read QuickHelp.txt of FullHelp.txt of ipsc)

• Normal index(more) page will contain 20 items

• Small index(more) page will contain 10 items

• VerySmall index(more) page will contain 5 items

• Big index(more) page will contain 30 items

Example:

ipsd -Command RunMonitor -MonitorFolder "F:\WatchdogSpace" -IndexPageSize "VerySmall"

• List Normal File

ipsd -Command ListNormalFile -MonitorFolder 

List all the normal files that already added to the connected site project

Example:

ipsd -Command ListNormalFile -MonitorFolder "F:\WatchdogSpace"

Build Working Environment

IPSD must work with IPSC , you need to do as following to create a environment to create static site.

1. Download IPSD

2. Download IPSC

3. Unzip IPSD

4. Unzip IPSC

5. Copy all the files to IPSD folder

6. Add this path to PATH environment variable

7. Install pandoc

   https://pandoc.org

   Install it as following KB :

   https://pandoc.org/installing.html

   Open command (cmd for Windows, shell for Linux/macOS) , run pandoc -v ,it should return the version information

8. Install a markdown editor , Typora or Visual Studio Code (need to install markdown extension) recommended.

   https://typeora.io

   https://code.visualstudio.com

9. Create ipsc source folder(F:\TestSite) and ipsc output folder(F:\SiteOutputFolder), then use IPSC to create a ipsc site project

  ipsc -Command "NewSite" -SiteFolder "F:\TestSite" -SiteTitle "Test Site" -SiteAuthor "Chao(sdxianchao@gmail.com)" -SiteDescription "Test Site for IPSC" -OutputFolder "F:\SiteOutputFolder"

Note: run this command with administrator permission (windows:Run as Administrator, Linux/Mac sudo), because ipsc need to call makesoftlink function when it create output folder, and this function need administrator permission.

You can also don't use OutputFolder argument, then there will be an output folder under site folder created(F:\TestSite\output)

  ipsc -Command "NewSite" -SiteFolder "F:\TestSite" -SiteTitle "Test Site" -SiteAuthor "Chao(sdxianchao@gmail.com)" -SiteDescription "Test Site for IPSC"

Note: if the command not works as you expected, check the ipsc.log in the folder that ipsc locates.

10. Create a empty original source folder for IPSD. Now there are three folders

• Orignial Folder F:\WatchdogSpace which contains the orginal files for the site
• Site Source Folder F:\TestSite which contains files for the ipsc site
• Site Output Folder F:\SiteOutputFolder which contains generated files of site

11. Connect Original source folder with IPSC by ipsd

ipsd -Command NewMonitor -SiteFolder "F:\TestSite" -SiteTitle "Test Site" -MonitorFolder "F:\WatchdogSpace"

Note: if the command not works as you expected, check the ipsd.log in the folder that ipsc locates.

How it works

There are a original source folder which contains source files, it looks like

• Files // The files contained in this folder will be added to IPSC as normal file

  • SubFolder1
    • SubFile1
    • SubFile2
  • SubFolder2
  • File1
  • File2

• Html //The files contained in this folder will be added to ipsc as HTML file

  • H1.html
  • H1.png //xx.png will be used as title iamge for xx.html
  • H2.html
  • H2.png

• Link

  • Link.txt //Links in this file will be added to IPSC as hyperlink
  • L1.png //xx.png will be used as title image for link xx
  • L2.png

• Markdown //Markdown files in this folder will be added to IPSC as markdown file

  • M1.md
  • M1.png //xx.png will be used as title image for xx.md
  • M2.md
  • M2.png

• Templates

  • Blank.md
  • News.md

• monitor.sm //definition file

You can add/remove/update md,html and link in this folder, add/remove/update their meta data or title iamge. Before that, you need to connect this folder with a ipsc site project. After you modified the orginial folder,run call ipsd to run monitor, ipsd will check this folder and send all the changes(Add/Remove/Update) to IPSC adn call ipsc to compile the site again.

Edit and generate site

1. Add File

• Markdown File

1. Open original source folder->Templates Folder, copy a md file as template

2. Open it with Markdown Editor

3. Edit the file

4. Modify Meta data as follows (DON'T change METADATA_END_29b43fcf-5b71-4b15-a048-46765f5ef048)

5. Save the file

6. Create a png image with the same name, and its size should be smaller than 30 KB

7. Copy md and png file to the Original Source Folder->Markdown

• Html File

1. Create a new Html File

2. Modify the meta data

3. Save the file

4. Create a png image with the same name, and its size should be smaller than 30 KB

5. Copy md and png file to the Original Source Folder->Html

• Link

  1.Add link to the Link.txt as follows orignial [] Add first link ["https://www.google.com||google|true"]

  https://www.google.com is the Url || empty is the id for this item in ipsc site project,now it is empty, and ipsd will update it after it added this link to the ipsc site google is the title that will display in the index Pages true the link will on top of the page, false will not on top

  2. Create a title image named google, such as google.png google.jpg and put it with the same folder of Link.txt
  3. Run ipsd RunMonitor, this item will be updated to ["https://www.google.com|f0454d7349d4a2aa222a5ede0cc2e129|google|true"]

  Now you have already has an item in the Link.txt, if you want to add another one

  1. Add link ["https://www.google.com|f0454d7349d4a2aa222a5ede0cc2e129|google|true","https://www.microsoft.com||microsoft|false"]
  2. Add an title image in to the folder , named microsoft.jpg
  3. Run ipsd RunMonitor, link will be added to the ipsc site and compile the site
  4. The item will be updated to ["https://www.google.com|f0454d7349d4a2aa222a5ede0cc2e129|google|true","https://www.microsoft.com|662731e8effd72ac2386c2e6a015bbee|microsoft|true"]

if you want to update the item, you can update the name and true or false. if you want to update the url, delete it and add again

If you want to delete it, just delete it from Link.txt, then run ipsd RunMonitor

• Normal File

  Copy a file or folder to Originial Source Folder->Files

2. Run Monitor

Run ipsd RunMonitor command, this command will push changes from orignial folder to ipsc source folder,then call ipsc to compile the site again, generate new site in ipsc output folder.

ipsd -Command RunMonitor -MonitorFolder "F:\WatchdogSpace" -IndexPageSize "VerySmall"

If you already monitored the ipsc folder with ipsp, ipsp will publish the new site to ipfs.

If you decided to publish the generated site to web server, now you can check the site with browser.

Publish site to IPFS

2. Download IPSP and unzip it

3. Use IPSP to monitor IPSC output folder

ipsp -SiteFolder "F:\TestSite" -MonitorInterval XXX

3. When you generate site and the file in output folder updated, ipsp will publish it to ipfs after MonitorInterval

Raise A Issue

Send email to sdxianchao@gmail.com

Maintainers

@aStarProgrammer.

License

MIT

HomePage

• Github

  https://github.com/astarprogrammer/ipsc

• IPFS

  http://localhost:8080/ipns/QmYY127PK6pczLrEB1p1mijTFr8RsvRqKFX5q4XepxS1fd/

​ Visit the following page for how to connect ipfs network and visit the above web site

​ https://ipfs.io