ipfswebui

README

Berty is a secure peer-to-peer messaging app that works with or without internet access, cellular data or trust in the network

IPFS webui embedded in an easy-to-import golang library.

This repo allows another golang project to embed the IPFS webui easily.

The "master" branch contains the generation and release scripts but is not directly usable.

Install

go get berty.tech/ipfs-webui-packed

Getting Started

import ipfswebui "berty.tech/ipfs-webui-packed"

dir := http.FileServer(ipfswebui.Dir())
http.ListenAndServe(":3000", dir)

Troubleshooting

(please use issues)

Development

TODO

Architecture

TODO

Testing

TODO

Contributing

If you want to help out, please see CONTRIBUTING.md.

This repository falls under the Berty Code of Conduct.

You can contact us on the #dev-💻 channel on discord.

License

ipfs-webui

This project embeds ipfs-webui which is licensed under MIT (https://github.com/ipfs-shipyard/ipfs-webui/blob/master/LICENSE).

Rest of the repo (scripts and helpers)

Dual-licensed under Apache 2.0 and MIT terms.

SPDX-License-Identifier: (Apache-2.0 OR MIT)

See the COPYRIGHT file for more details.

Documentation

Overview

Example

package main

import (
	"fmt"

	ipfswebui "berty.tech/ipfs-webui-packed"
)

func main() {
	fmt.Println(ipfswebui.Dir())
}

Output:

/webui

Example (Http)

package main

import (
	"net/http"

	ipfswebui "berty.tech/ipfs-webui-packed"
)

func main() {
	dir := http.FileServer(ipfswebui.Dir())
	http.ListenAndServe(":3000", dir)
}

Index

• func Dir() pkger.Dir

Examples

• Package
• Package (Http)

Functions

func Dir

func Dir() pkger.Dir