https://github.com/mapkyca/known-ipfs

IPFS backend file support for Known
https://github.com/mapkyca/known-ipfs

Last synced: 7 days ago
JSON representation

IPFS backend file support for Known

• Host: GitHub
• URL: https://github.com/mapkyca/known-ipfs
• Owner: mapkyca
• Created: 2019-02-12T12:11:21.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-27T08:15:28.000Z (about 4 years ago)
• Last Synced: 2024-08-07T17:30:30.983Z (3 months ago)
• Language: PHP
• Size: 1.5 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Known IPFS Support (experimental) [![DOI](https://zenodo.org/badge/170312056.svg)](https://zenodo.org/badge/latestdoi/170312056)

This plugin adds IPFS file support to Known.

## Installation

Step Zero: Install an IPFS server. This is a little bit out of scope, but I used [go-ipfs](https://docs.ipfs.io/introduction/install/) during development.

Once you've done that:

* Download the latest version of Known. I recommend that you either use the [GitHub](https://github.com/idno/known) version or the [Unofficial packages](https://www.marcus-povey.co.uk/known) available from my website.

* Create an **IPFS** directory in your ```IdnoPlugins``` directory, and copy these files into it.

* Activate it from the Admin panel.

or

* ``` composer require mapkyca/known-ipfs ```

## Configuration

The IPFS plugin will default to using ```localhost:8080```. If you want to change this, you will need to modify your ```config.ini``` as follows:

```

[IPFS]

host = 'servername'

port = 1234

apiport = 5678

```

Replace the values accordingly, but make sure you keep the ```[IPFS]``` section header.

## Known Issues

This software is very much experimental at the moment, but feel free to issues in github. 

That said, I know about:

### Don't run composer

The plugin makes use of the [php-ipfs-api](https://github.com/cloutier/php-ipfs-api) library. 

Unfortunately, the version that is currently available via composer has a small bug that corrupts uploaded data, and so I had to fix the error in place. 

I have [filed an issue](https://github.com/cloutier/php-ipfs-api/issues/12) with the author, but the composer package is updated to what's currently on github, running a ```composer install``` will likely break the plugin.

## Still to do

This plugin functionally does not change how files are actually stored - a local object is still created , although the data itself is stored elsewhere. 

Could this be done more efficiently? For example, could a direct link be provided? Likely this would require some core hooks - for example a getFileURL() on file objects.

## See

* Author: [Marcus Povey](https://www.marcus-povey.co.uk)