Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 1af30c1

Browse files
committed
docs: add a note to the default values to the readme
1 parent a4e9fbe commit 1af30c1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The last published version of the package become [available for download](htt
120120

121121
The `jsipfs` CLI, available when `js-ipfs` is installed globably, follows(should, it is a WIP) the same interface defined by `go-ipfs`, you can always use the `help` command for help menus.
122122

123-
```
123+
```sh
124124
# Install js-ipfs globally
125125
> npm install ipfs --global
126126
> jsipfs --help
@@ -134,6 +134,12 @@ Commands:
134134
# ...
135135
```
136136

137+
`js-ipfs` uses some different default config values, so that they don't clash directly with a go-ipfs node running in the same machine. These are:
138+
139+
- default repo location: `~/.jsipfs` (can be changed with env variable `IPFS_PATH`)
140+
- default swarm port: `4002`
141+
- default API port: `5002`
142+
137143
### HTTP-API
138144

139145
The HTTP-API exposed by the js-ipfs daemon follows the [`http-api-spec`](https://github.com/ipfs/http-api-spec). You can use any of the IPFS HTTP-API client libraries with it, such as: [js-ipfs-api](https://github.com/ipfs/js-ipfs-api).

0 commit comments

Comments
 (0)