Commit Graph

246 Commits

Author SHA1 Message Date
Marcin Rataj
f994d94025 docs(readme): update min. requirements + cleanup (#10750)
* docs(readme): update min. requirements + cleanup

Adding note about extra memory requirement due to
ba22102a64

* docs(config): memory cost of buffered provider

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>
(cherry picked from commit 96f3007b55)
2025-03-14 18:21:31 +01:00
Marcin Rataj
f00e115e1e
docs(readme): update docker section (#10716)
Some checks failed
CodeQL / codeql (push) Has been cancelled
Docker Build / docker-build (push) Has been cancelled
Gateway Conformance / gateway-conformance (push) Has been cancelled
Gateway Conformance / gateway-conformance-libp2p-experiment (push) Has been cancelled
Go Build / go-build (push) Has been cancelled
Go Check / go-check (push) Has been cancelled
Go Lint / go-lint (push) Has been cancelled
Go Test / go-test (push) Has been cancelled
Interop / interop-prep (push) Has been cancelled
Sharness / sharness-test (push) Has been cancelled
Spell Check / spellcheck (push) Has been cancelled
Interop / helia-interop (push) Has been cancelled
Interop / ipfs-webui (push) Has been cancelled
2025-02-18 21:59:53 +01:00
Marcin Rataj
ad81ead4f4
docs: update min requirements (#10687)
https://docs.ipfs.tech/install/command-line/#system-requirements 
states 6 GiB, updating readme to match that
2025-02-05 22:26:33 +01:00
Michael Vorburger
17682040c5
docs(readme): add unofficial Fedora COPR (#10660)
Some checks are pending
CodeQL / codeql (push) Waiting to run
Docker Build / docker-build (push) Waiting to run
Gateway Conformance / gateway-conformance (push) Waiting to run
Gateway Conformance / gateway-conformance-libp2p-experiment (push) Waiting to run
Go Build / go-build (push) Waiting to run
Go Check / go-check (push) Waiting to run
Go Lint / go-lint (push) Waiting to run
Go Test / go-test (push) Waiting to run
Interop / interop-prep (push) Waiting to run
Interop / helia-interop (push) Blocked by required conditions
Interop / ipfs-webui (push) Blocked by required conditions
Sharness / sharness-test (push) Waiting to run
2025-01-15 02:12:47 +01:00
Andrew Gillis
4e91ea3220
Minor spelling and wording changes (#10634)
*Update readme

Closes #10627
2024-12-19 16:06:56 -08:00
Marcin Rataj
6454bdb4ea
chore: boxo v0.23.0 and go-libp2p v0.36.3 (#10507)
https://github.com/libp2p/go-libp2p/releases/tag/v0.36.3
https://github.com/ipfs/boxo/releases/tag/v0.23.0
2024-09-05 23:52:19 +02:00
Vitaly Zdanevich
7500922f5a
docs(readme): add Gentoo Linux (#10474) 2024-08-12 14:17:07 +02:00
Andrei Vukolov
c2bdd61997
Documented unofficial Ubuntu PPA
Documented unofficial installation package located in Ubuntu PPA  maintained by @twdragon
2024-08-02 12:30:29 +02:00
Marcin Rataj
5af3cc1c02
docs: updated links and refs to external resources (#10368) 2024-03-16 00:59:22 +01:00
Hector Sanjuan
a0f34b16dd
feat: built-in content blocking based on IPIP-383 (#10161)
Fixes #8492

This introduces "nopfs" as a preloaded plugin into Kubo
with support for denylists from https://github.com/ipfs/specs/pull/383

It automatically makes Kubo watch *.deny files found in:

- /etc/ipfs/denylists
- $XDG_CONFIG_HOME/ipfs/denylists
- $IPFS_PATH/denylists

* test: Gateway.NoFetch and GatewayOverLibp2p

adds missing tests for "no fetch" gateways one can expose,
in both cases the offline mode is done by passing custom
blockservice/exchange into path resolver, which means
global path resolver that has nopfs intercept is not used,
and the content blocking does not happen on these gateways.

* fix: use offline path resolvers where appropriate

this fixes the problem described in
https://github.com/ipfs/kubo/pull/10161#issuecomment-1782175955
by adding explicit offline path resolvers that are backed
by offline exchange, and using them in NoFetch gateways
instead of the default online ones

---------

Co-authored-by: Henrique Dias <hacdias@gmail.com>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
2023-10-28 05:34:14 +02:00
Marten Seemann
4f303d3208
docs: remove OpenSSL section from README (#10186) 2023-10-26 13:30:43 +02:00
Marcin Rataj
edce05c4cf
docs(readme): header improvements (#10144) 2023-09-25 10:07:26 +02:00
Marcin Rataj
c349248891
docs(readme): new logo and header 2023-08-22 11:20:14 +02:00
Marcin Rataj
0c57a4f622
docs(readme): minimal reqs (#10066) 2023-08-14 15:45:36 +02:00
Marcin Rataj
c5cc835fb8 docs(readme): unofficial packages badge 2023-08-07 16:13:20 +02:00
Jorropo
eda19c8abe
chore: fix nix install options (#9887)
See: eefaaf41d6

Fixes: #9752
2023-05-23 10:42:14 +02:00
galargh
ceed43ea0e chore: clean up after circleci removal 2023-03-21 14:57:14 +01:00
Jorropo
1f5763f787 chore: deprecate the pubsub api
Fixes #9717
2023-03-15 04:42:02 +01:00
Piotr Galar
204b8428bf
docs(readme): update package managers section (#9488) 2022-12-12 00:12:21 +01:00
Marcin Rataj
3b00c81c8d docs: remove snap and chocolatey packages
See
https://github.com/ipfs/kubo/issues/8688
https://github.com/ipfs/kubo/issues/9341
2022-11-28 15:55:57 +01:00
Russell Dempsey
a32128d1d3
docs: ipfs-http-client -> kubo-rpc-client (#9331)
Fixes https://github.com/ipfs/js-kubo-rpc-client/issues/35

Co-authored-by: Steve Loeppky <stvn@loeppky.com>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
2022-11-22 23:19:27 +01:00
Marcin Rataj
1e90efb75d docs(readme): improve tldr 2022-11-22 17:05:06 +01:00
Gus Eggert
27bf61ecc3
docs: update scoop package 2022-10-20 11:13:18 -04:00
Jamie Dubs
052d797ca7
docs: Fix typo and grammar in README 2022-10-07 22:11:05 +02:00
@RubenKelevra
c7ed7ba722
Readme: Rewrite introduction and featureset (#9211)
* Readme: Rewrite introduction and featureset

* Readd links

Co-authored-by: Gus Eggert <gus@gus.dev>
2022-09-22 13:28:49 -04:00
Eli Bailey
aad1219529
docs: change windows choco install command to point to go-ipfs
Changes code example to use (what I believe is the) correct installation: https://community.chocolatey.org/packages/go-ipfs
2022-09-06 17:47:00 +02:00
Marcin Rataj
426cb84255 docs(readme): official vs unofficial packages 2022-08-31 15:00:27 +02:00
Marcin Rataj
bb59c052c2 docs(readme): update Docker section 2022-08-30 15:35:35 +02:00
Marcin Rataj
837f6ee92b chore: switch to dist.ipfs.tech
Part of https://github.com/protocol/bifrost-infra/issues/2018
ensures the domain used for fetching migrations is not
impacted by ipfs.io being blocked at DNS level by some ISPs.
2022-08-12 23:42:17 +02:00
Seungbae Yu
cb280cbf16
docs: replace docs.ipfs.io with docs.ipfs.tech (#9158)
* docs: fix redirecting URL in README.md
* all: replace `docs.ipfs.io` with `docs.ipfs.tech`
* apply suggestions from code review

Co-authored-by: Marcin Rataj <lidel@lidel.org>
2022-08-05 19:01:10 +03:00
link2xt
846d362581
docs: update Arch Linux installation instructions
Package is named `kubo`, not `go-ipfs` now.
2022-07-25 20:43:56 +02:00
Steve Loeppky
3902c9be00
docs(readme): add maintainer info (#9141)
* Update readme with important maintainer info.

The release process should have more visibility.  For now just getting the links at least surfaced.
2022-07-23 02:29:25 +02:00
Daniel Norman
5b1e04a7b8 fix: typo in README 2022-07-21 15:52:38 +00:00
Steve Loeppky
639155c732
docs(readme): move content to docs website (#9102)
- point towards other implementations.
- add a link to a future ipfs-implementations doc
- link to IPFS in GO docs

Co-authored-by: Marcin Rataj <lidel@lidel.org>
2022-07-20 15:53:41 +02:00
Marcin Rataj
9dbc9dfeb2 fix(cmds): use kubo in CheckVersionOption
Using both names to avoid dev problems during the transition from go-ipfs 0.13 to kubo 0.14
2022-07-06 23:08:31 +02:00
Marcin Rataj
3417ed466f docs: kubo description from dist.ipfs.io
:-)
2022-07-06 18:40:39 +02:00
Marcin Rataj
b9240fe432 refactor(docker): publish images under both names
This ensures we keep publishing the same image under both names:

    $ ./bin/get-docker-tags.sh $(date -u +%F) 88d88158c master                                                                                                                                 ...chore/rename-to-banana
    ipfs/kubo:master-2022-06-21-88d8815
    ipfs/go-ipfs:master-2022-06-21-88d8815
    ipfs/kubo:master-latest
    ipfs/go-ipfs:master-latest
2022-07-06 18:40:39 +02:00
Marcin Rataj
5cb572660d docs(readme): rename to kubo
some things like third party package names, docker image etc need to
stay as go-ipfs for now
2022-07-06 18:40:39 +02:00
Marcin Rataj
82467bc936 refactor: rename to kubo 2022-07-06 18:40:37 +02:00
Marcin Rataj
b6ded334ec
docs: add SECURITY.md (#9062)
* docs: add SECURITY.md

This moves existing security policy from README to SECURITY.md
which has a special meaning on Github:
https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository

* style: editoral fix

Co-authored-by: Steve Loeppky <biglep@protocol.ai>
2022-06-28 18:51:37 +02:00
Ikko Ashimine
b36044be34
chore: GitHub format 2022-06-09 17:36:51 +02:00
Laurent Senta
c9cf47dad5 config: remove go-ipfs-config code 2022-03-04 09:45:16 +01:00
Gus Eggert
2a871ef018
docs: add Snap note about customizing IPFS_PATH (#8584) 2022-01-06 08:58:33 -05:00
falstack
c00065cc84
chore: fix link in README.md (#8551)
update docs issues link
2021-11-23 23:41:26 +01:00
Yi Cao
3d9cb78ef1
Merge pull request #8545 from xiaoyu2006/patch-1
Add Homebrew installation method.
2021-11-10 10:32:43 -05:00
@RubenKelevra
04d1369a63 add more buttons; remove some sections covered in the docs; general cleanup
- added dynamic buttons for packages/downloads which shows the latest version where possible
- dynamic next milestone buttons
- reordered to have package managers and docker on top, manual downloads afterwards
- remove the docker and the cli section, since they are covered equally in the docs + button links
- added more sections to the navigation, to find stuff easier
- dynamic go requirement version button
- some social media buttons
- general cleanup
2021-09-02 12:22:54 +02:00
Steven Allen
9398d80878
Merge pull request #8220 from ShadSterling/patch-1
README.md: Add MacPorts to install section
2021-08-10 09:47:22 -07:00
Marcin Rataj
eda8b43a28 docs: chocolatey package name
We use go-ipfs name now, to make it clear that it is not ipfs-desktop.
2021-07-23 08:35:03 -07:00
Steven Allen
0060d5f7c8 feat: programmatic shell completions
These are missing some of the features of the current hand-rolled
completions, but:

1. Are less buggy.
2. Cover _all_ commands.
3. Don't need to be manually maintained (which we never do anyways).

fixes #4551
fixes #8033
2021-07-01 08:46:49 -07:00
Steven Allen
885325dd19 doc(README): update chat links (and misc fixes)
- Remove ipn.io link...
- Remove chat "badges" and replace with a single link.
- Remove reference to weekly meetings that no longer exist.

fixes #8190
2021-06-28 11:35:57 -07:00