Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 3.89 KB

README.md

File metadata and controls

87 lines (55 loc) · 3.89 KB
Raw

IPFSBin

Circle CI

IPFSBin Screenshot

IPFSBin is a pastebin application for sharing code and text documents to other people. It supports 81 languages and works even if you don't have access to the internet anymore.

When you first load the application, we download and store everything in the browser. Therefore a connection is not required to use IPFSBin after the initial load.

Basic Usage

  1. Navigate to ipfsbin.xyz

  2. Remove the content already visible and paste your own content

  3. Click on save in the top right

  4. Copy the new URL from your addressbar

  5. Send to your friend

  6. Profit!!

Raw mode/Plain text

If you want, you can work directly with plain text pastes instead of storing JSON objects. Try loading the IPFS security notes directly in IPFSBin: http://ipfsbin.xyz/#QmTumTjvcYCAvRRwQ8sDRxh8ezmrcr88YFU7iYNroGGTBZ

If you want to save your own plain text pastes, simply select the "Plain Text" mode and hit save.

Support

If you have any questions, open a Github issue here: github.com/VictorBjelkholm/ipfsbin/issues/new

or feel free to contact me on Twitter here: @VictorBjelkholm

Requirements for offline usage

  • Already running IPFS daemon IPFS Homepage
    • (Run with API_ORIGIN="*" ipfs daemon to allow IPFSBin access to the local IPFS API)
  • Webserver of choice, (python sample provided)

Running offline

Browser cached copy Visit ipfsbin.xyz in your favorite browser, and you have installed IPFSBin in that browser. If you clear the browser cache, you might lose it and it has to be cached again by being online and loading the page. If an update have been released and you're online, it will be installed when you reload the page. If you're offline, the old version will still work.

Offline: You can also run the application locally by cloning the project and start webserver of choice, serving the root folder. npm run prod is a handy command for serving the applications folder with connect.

git clone https://github.com/VictorBjelkholm/ipfsbin.git
cd ipfsbin
npm install
npm run prod # only needed on creation/update

Visit localhost:3000 to navigate to IPFSBin.

Hacking / Contributing

You wish to contribute a feature or fix an annoying bug? Follow the instructions about running offline, but instead of npm run compile, run npm run dev and go to (localhost:3000)[localhost:3000]. When in dev mode, it automatically runs a local IPFS daemon so no need to worry.

License

The MIT License (MIT)

Copyright (c) 2015 Victor Bjelkholm

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.