Skip to content

Create Kubo RPC cli page #1695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ module.exports = {
collapsable: true,
path: '/reference/kubo/rpc'
},
'/reference/kubo-rpc-cli.md'

],
'/community/': [
Expand Down
18 changes: 9 additions & 9 deletions docs/how-to/spheron.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ description: Learn about Spheron.

Deploying static apps on Spheron is a straightforward process. Follow these steps to deploy your static apps on Spheron:

1. **Connect your Git Provider:**<br/>
1. **Connect your Git Provider:**
Connecting your Git provider allows Spheron to sync your repositories and trigger deployments whenever new updates are made. Spheron supports the following [Git providers](https://docs.spheron.network/static/deployment/logs/): Github, Gitlab, and Bitbucket.

2. **Set up your Project:**<br/>
2. **Set up your Project:**
Create a new project on Spheron and choose your desired app repository for deployment.

3. **Select deployment protocol:**<br/>
3. **Select deployment protocol:**
Select your desired protocol for hosting your static app. Spheron supports the following protocols: **Arweave**, **Filecoin**, and **IPFS**.

4. **Configure deployment settings:**<br/>
4. **Configure deployment settings:**
Spheron will automatically detect and configure most of these settings for you. You have to [add environment variables](https://docs.spheron.network/static/projects/variables/) in the dedicated section. If needed, modify the remaining parameters according to your requirements. That includes selecting the framework, branch, root directory, build and output settings, and the node engine.

5. **Trigger deployment:**<br/>
5. **Trigger deployment:**
After configuring all the required settings, initiate the deployment process. Spheron will fetch your code, build the static files, and deploy them to your specified protocol.

6. **Access your app:**<br/>
6. **Access your app:**
Once the deployment is complete, you can access your app through the domain generated by Spheron. You also have the option to [set up a custom domain](https://docs.spheron.network/static/projects/domain/) for your app.

> Checkout our [Framework Guide](https://docs.spheron.network/framework-guide/) for more info.
Expand All @@ -39,10 +39,10 @@ Deploying static apps on Spheron is a straightforward process. Follow these step

Deploying compute instances on Spheron is simple and effortless, whether you're using a Docker image from Docker Hub or deploying a marketplace app. Follow these steps to deploy your compute instance on Spheron:

1. **Set up your Cluster:**<br/>
1. **Set up your Cluster:**
Create a new cluster on Spheron by selecting **Import from Docker Hub** or **Start from Marketplace App**.

2. **For Docker Hub:**<br/>
2. **For Docker Hub:**

1. Click "New Cluster" on the top right corner.
2. Select **Import from Docker Hub**.
Expand All @@ -64,7 +64,7 @@ Deploying compute instances on Spheron is simple and effortless, whether you're

> Checkout our [Server Guide](https://docs.spheron.network/server-guide/) for more info.

3. **For Marketplace App:**<br/>
3. **For Marketplace App:**

1. Click "New Cluster" on the top right corner.
2. Select **Start from Marketplace App**.
Expand Down
38 changes: 38 additions & 0 deletions docs/reference/kubo-rpc-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Kubo RPC API clients
description: List of Kubo RPC API clients.
---

# Kubo RPC API clients

When a Kubo IPFS node is running as a daemon, it exposes an HTTP RPC API that allows you to control the node and run the same commands you can from the command line. To learn more about the RPC API, see the [Kubo RPC API v0 reference](./kubo/rpc.md).

RPC API clients are available in multiple languages, and are listed below. You can request that additional clients be added to this list by [opening an issue in ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs/issues/new?assignees=&labels=need%2Ftriage&projects=&template=open_an_issue.md&title=).


| Language | Client library | Status |
|---------------|-----------------------------------------------------------|---------------------|
| Go | [ipfs/go-ipfs-api](https://github.com/ipfs/go-ipfs-api) | Active |
| Java | [ipfs-shipyard/java-ipfs-http-client](https://github.com/ipfs-shipyard/java-ipfs-http-client) | Active |
| JavaScript | [ipfs/js-ipfs/tree/master/packages/ipfs-http-client](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client) | Active |
| Python | [ipfs-shipyard/py-ipfs-http-client](https://github.com/ipfs-shipyard/py-ipfs-http-client) | Active |
| Scala | [ipfs-shipyard/scala-ipfs-api](https://github.com/ipfs-shipyard/scala-ipfs-api) | Inactive |
| Clojure | [keorn/clj-ipfs-http-client](https://github.com/keorn/clj-ipfs-http-client) | Active |
| Clojurescript | [district0x/cljs-ipfs-http-client](https://github.com/district0x/cljs-ipfs-http-client) | Active |
| Haskell | [davidar/hs-ipfs-api](https://github.com/davidar/hs-ipfs-api) | Inactive |
| Swift | [ipfs-shipyard/swift-ipfs-http-client](https://github.com/ipfs-shipyard/swift-ipfs-http-client) | Active |
| CommonLisp | [WeMeetAgain/cl-ipfs-api](https://github.com/WeMeetAgain/cl-ipfs-api) | Inactive |
| Rust | [ferristseng/rust-ipfs-api](https://github.com/ferristseng/rust-ipfs-api) | Active |
| | [gkbrk/rust-ipfs-api](https://github.com/gkbrk/rust-ipfs-api) | Inactive |
| | [rmnoff/rust-ipfs-api](https://github.com/rmnoff/rust-ipfs-api) | Inactive |
| | [rschulman/rust-ipfs-api](https://github.com/rschulman/rust-ipfs-api) | Inactive |
| Ruby | [Fryie/ipfs-ruby](https://github.com/Fryie/ipfs-ruby) | Inactive |
| | [tbenett/ruby-ipfs-http-client](https://github.com/tbenett/ruby-ipfs-http-client) | Active |
| Mac Automator | [NeoTeo/ipfs-osx-service](https://github.com/NeoTeo/ipfs-osx-service) | Inactive |
| Pharo | [khinsen/ipfs-pharo](https://github.com/khinsen/ipfs-pharo) | Active |
| PHP | [cloutier/php-ipfs-api](https://github.com/cloutier/php-ipfs-api) | Inactive |
| | [digitalkaoz/php-ipfs-api](https://github.com/digitalkaoz/php-ipfs-api) | Inactive |
| C# | [jeremy-ellis-tech/net-ipfs-http-client](https://github.com/jeremy-ellis-tech/net-ipfs-http-client) | Inactive |
| | [richardschneider/net-ipfs-http-client](https://github.com/richardschneider/net-ipfs-http-client) | Active |
| C++ | [vasild/cpp-ipfs-api](https://github.com/vasild/cpp-ipfs-api) | Active |
| Erlang | [hendry19901990/erlang-ipfs-http-client](https://github.com/hendry19901990/erlang-ipfs-http-client) | Inactive |