diff --git a/images/docker-ipfs.md b/images/docker-ipfs.md index 726d6d1d9..c90299255 100755 --- a/images/docker-ipfs.md +++ b/images/docker-ipfs.md @@ -1,6 +1,9 @@ --- title: ipfs --- + + + # [linuxserver/ipfs](https://github.com/linuxserver/docker-ipfs) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-ipfs.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-ipfs) @@ -15,7 +18,6 @@ title: ipfs [Ipfs](https://ipfs.io/) - A peer-to-peer hypermedia protocol designed to make the web faster, safer, and more open. - ## Supported Architectures Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). @@ -30,6 +32,19 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +In order to push files beyond your local gateway you have to make sure port 4001 is forwarded to the internet. This is required for IPFS peers to reach in and grab your files so public gateways can serve them. + +Access the webui at http://localhost , if not using localhost scroll to the bottom of the page and set the API Address setting to IE http://192.168.1.10:5001 , from there you can upload and manage files you push to IPFS. Your gateway to access IPFS files is http://localhost:8080/ipfs/YOUR-FILE-HASH-HERE . You can also simply use public IPFS gateways like: +* Cloudflare - https://cloudflare-ipfs.com/ipfs/YOUR-FILE-HASH-HERE +* IPFS.io - https://ipfs.io/ipfs/YOUR-FILE-HASH-HERE +* Eternum.io - https://ipfs.eternum.io/ipfs/YOUR-FILE-HASH-HERE + +Cloudflare is a solid option as they actually edge cache the files on their CDN so even if your node pinning the item goes down for periods of time their cache will last up to a month. + +For more on using IPFS please read the docs [here](https://docs.ipfs.io/) + ## Usage @@ -63,7 +78,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=ipfs \ -e PUID=1000 \ @@ -79,7 +94,6 @@ docker run -d \ ghcr.io/linuxserver/ipfs ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. @@ -94,7 +108,6 @@ Docker images are configured using parameters passed at runtime (such as those a | `8080` | Gateway Port, actually serves IPFS content | | `443` | HTTPS port for web UI | - ### Environment Variables (`-e`) | Env | Function | @@ -109,15 +122,13 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | IPFS storage and config files/logs | - - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -128,7 +139,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support. - ## User / Group Identifiers When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. @@ -137,32 +147,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -In order to push files beyond your local gateway you have to make sure port 4001 is forwarded to the internet. This is required for IPFS peers to reach in and grab your files so public gateways can serve them. - -Access the webui at http://localhost , if not using localhost scroll to the bottom of the page and set the API Address setting to IE http://192.168.1.10:5001 , from there you can upload and manage files you push to IPFS. Your gateway to access IPFS files is http://localhost:8080/ipfs/YOUR-FILE-HASH-HERE . You can also simply use public IPFS gateways like: -* Cloudflare - https://cloudflare-ipfs.com/ipfs/YOUR-FILE-HASH-HERE -* IPFS.io - https://ipfs.io/ipfs/YOUR-FILE-HASH-HERE -* Eternum.io - https://ipfs.eternum.io/ipfs/YOUR-FILE-HASH-HERE - -Cloudflare is a solid option as they actually edge cache the files on their CDN so even if your node pinning the item goes down for periods of time their cache will last up to a month. - -For more on using IPFS please read the docs [here](https://docs.ipfs.io/) - - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=ipfs&query=%24.mods%5B%27ipfs%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=ipfs "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above. - ## Support Info * Shell access whilst the container is running: