Skip to content

Commit

Permalink
Merge pull request #3200 from filecoin-project/asr/docs
Browse files Browse the repository at this point in the history
Update links
  • Loading branch information
arajasek authored Aug 20, 2020
2 parents 87f1b75 + 807504f commit d8a669c
Show file tree
Hide file tree
Showing 17 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

## 0.1.0 / 2019-12-11

We are very excited to release **lotus** 0.1.0. This is our testnet release. To install lotus and join the testnet, please visit [docs.lotu.sh](docs.lotu.sh). Please file bug reports as [issues](https://github.com/filecoin-project/lotus/issues).
We are very excited to release **lotus** 0.1.0. This is our testnet release. To install lotus and join the testnet, please visit [lotu.sh](lotu.sh). Please file bug reports as [issues](https://github.com/filecoin-project/lotus/issues).

A huge thank you to all contributors for this testnet release!
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://docs.lotu.sh/" title="Lotus Docs">
<a href="https://lotu.sh/" title="Lotus Docs">
<img src="documentation/images/lotus_logo_h.png" alt="Project Lotus Logo" width="244" />
</a>
</p>
Expand All @@ -18,7 +18,7 @@ Lotus is an implementation of the Filecoin Distributed Storage Network. For more

## Building & Documentation

For instructions on how to build lotus from source, please visit [https://docs.lotu.sh](https://docs.lotu.sh) or read the source [here](https://github.com/filecoin-project/lotus/tree/master/documentation).
For instructions on how to build lotus from source, please visit [https://lotu.sh](https://lotu.sh) or read the source [here](https://github.com/filecoin-project/lotus/tree/master/documentation).

## Reporting a Vulnerability

Expand Down
2 changes: 1 addition & 1 deletion cmd/lotus-fountain/site/_miner.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<span>When creating miner, DO NOT REFRESH THE PAGE, wait for it to load. This can take more than 5min.</span>
</div>
<div class="Index-node">
<span>If you don't have an owner/worker address, you can create it by following <a target="_blank" href="https://docs.lotu.sh/en+mining#get-started-22083">these instructions</a>.</span>
<span>If you don't have an owner/worker address, you can create it by following <a target="_blank" href="https://lotu.sh/en+mining#get-started-22083">these instructions</a>.</span>
</div>
</div>
<div class="Index-footer">
Expand Down
2 changes: 1 addition & 1 deletion documentation/en/dev-tools-pond-ui.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pond UI

Pond is a graphical testbed for [Lotus](https://docs.lotu.sh). Using it will setup a separate local network which is helpful for debugging. Pond will spin up nodes, connect them in a given topology, start them mining, and observe how they function over time.
Pond is a graphical testbed for [Lotus](https://lotu.sh). Using it will setup a separate local network which is helpful for debugging. Pond will spin up nodes, connect them in a given topology, start them mining, and observe how they function over time.

## Build

Expand Down
2 changes: 1 addition & 1 deletion documentation/en/dev/create-miner.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ It is important to note that the key store also holds the *private* key associat

There is no explicit Filecoin message or CLI command that creates an account actor but rather it is implicit in the public-key address reflected by the wallet. The first time the VM sees it as the receiving address of a Filecoin message it will automatically create the associated account actor.

We will trigger its creation then by sending funds to it, needed for the creation of the storage miner (note this document reflects the Filecoin Testnet, where we actually don't need funds to create a miner but will do the full procedure regardless to show the full cycle). In the Testnet we can send funds to an account trough the [Faucet](https://faucet.testnet.filecoin.io/funds.html), inserting the address returned by the `wallet new` command.
We will trigger its creation then by sending funds to it, needed for the creation of the storage miner (note this document reflects the Filecoin Testnet, where we actually don't need funds to create a miner but will do the full procedure regardless to show the full cycle). In the Testnet we can send funds to an account through the [Faucet](http://spacerace.faucet.glif.io/), inserting the address returned by the `wallet new` command.

FIXME: Is there an easy way to visualize the message generated by the Faucet?

Expand Down
4 changes: 2 additions & 2 deletions documentation/en/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ to a Lotus Node over the JSON-RPC API.

### How do I set up a Lotus Node?

Follow the instructions found [here](https://docs.lotu.sh/en+getting-started).
Follow the instructions found [here](https://lotu.sh/en+getting-started).

### Where can I get the latest version of Lotus?

Expand All @@ -52,7 +52,7 @@ Stop the Lotus daemon, and delete all related files, including sealed and chain
running `rm ~/.lotus ~/.lotusminer`.

Then, install Lotus afresh by following the instructions
found [here](https://docs.lotu.sh/en+getting-started).
found [here](https://lotu.sh/en+getting-started).

### Can I configure where the node's config and data goes?

Expand Down
8 changes: 4 additions & 4 deletions documentation/en/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ For more details about Filecoin, check out the [Filecoin Docs](https://docs.file

## What can I learn here?

- How to install Lotus on [Arch Linux](https://docs.lotu.sh/en+install-lotus-arch), [Ubuntu](https://docs.lotu.sh/en+install-lotus-ubuntu), or [MacOS](https://docs.lotu.sh/en+install-lotus-macos).
- Joining the [Lotus Testnet](https://docs.lotu.sh/en+join-testnet).
- [Storing](https://docs.lotu.sh/en+storing-data) or [retrieving](https://docs.lotu.sh/en+retrieving-data) data.
- Mining Filecoin using the **Lotus Miner** in your [CLI](https://docs.lotu.sh/en+mining).
- How to install Lotus on [Arch Linux](https://lotu.sh/en+install-lotus-arch), [Ubuntu](https://lotu.sh/en+install-lotus-ubuntu), or [MacOS](https://lotu.sh/en+install-lotus-macos).
- Joining the [Lotus Testnet](https://lotu.sh/en+join-testnet).
- [Storing](https://lotu.sh/en+storing-data) or [retrieving](https://lotu.sh/en+retrieving-data) data.
- Mining Filecoin using the **Lotus Miner** in your [CLI](https://lotu.sh/en+mining).

## How is Lotus designed?

Expand Down
2 changes: 1 addition & 1 deletion documentation/en/install-lotus-arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ env env RUSTFLAGS="-C target-cpu=native -g" FFI_BUILD_FROM_SOURCE=1 make clean d
sudo make install
```

After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus Testnet](https://docs.lotu.sh/en+join-testnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus Testnet](https://lotu.sh/en+join-testnet).
2 changes: 1 addition & 1 deletion documentation/en/install-lotus-fedora.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ env env RUSTFLAGS="-C target-cpu=native -g" FFI_BUILD_FROM_SOURCE=1 make clean d
sudo make install
```

After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus TestNet](https://docs.lotu.sh/en+join-testnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus TestNet](https://lotu.sh/en+join-testnet).
2 changes: 1 addition & 1 deletion documentation/en/install-lotus-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ make clean && make all
sudo make install
```

After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus Testnet](https://docs.lotu.sh/en+join-testnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus Testnet](https://lotu.sh/en+join-testnet).
2 changes: 1 addition & 1 deletion documentation/en/install-lotus-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ sudo make install
```


After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus Testnet](https://docs.lotu.sh/en+join-testnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus Testnet](https://lotu.sh/en+join-testnet).
6 changes: 3 additions & 3 deletions documentation/en/join-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ In another terminal window, check your connection with peers:
lotus net peers | wc -l
```

In order to connect to the network, you need to be connected to at least 1 peer. If you’re seeing 0 peers, read our [troubleshooting notes](https://docs.lotu.sh/en+setup-troubleshooting).
In order to connect to the network, you need to be connected to at least 1 peer. If you’re seeing 0 peers, read our [troubleshooting notes](https://lotu.sh/en+setup-troubleshooting).

Make sure that you have a reasonable "open files limit" set on your machine, such as 10000. If you're seeing a lower value, such as 256 (default on macOS), read our [troubleshooting notes](https://docs.lotu.sh/en+setup-troubleshooting) on how to update it prior to starting the Lotus daemon.
Make sure that you have a reasonable "open files limit" set on your machine, such as 10000. If you're seeing a lower value, such as 256 (default on macOS), read our [troubleshooting notes](https://lotu.sh/en+setup-troubleshooting) on how to update it prior to starting the Lotus daemon.

## Chain sync

Expand Down Expand Up @@ -57,7 +57,7 @@ Here is an example of the response:
t1aswwvjsae63tcrniz6x5ykvsuotlgkvlulnqpsi
```

- Visit the [faucet](https://faucet.testnet.filecoin.io) to add funds.
- Visit the [faucet](http://spacerace.faucet.glif.io/) to add funds.
- Paste the address you created.
- Press the send button.

Expand Down
4 changes: 2 additions & 2 deletions documentation/en/mining-lotus-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ RemoteListenAddress = "127.0.0.1:2345"

To make your node accessible over the local area network, you will need to determine your machines IP on the LAN, and change the `127.0.0.1` in the file to that address.

A more permissive and less secure option is to change it to `0.0.0.0`. This will allow anyone who can connect to your computer on that port to access the [API](https://docs.lotu.sh/en+api). They will still need an auth token.
A more permissive and less secure option is to change it to `0.0.0.0`. This will allow anyone who can connect to your computer on that port to access the [API](https://lotu.sh/en+api). They will still need an auth token.

`RemoteListenAddress` must be set to an address which other nodes on your network will be able to reach.

Next, you will need to [create an authentication token](https://docs.lotu.sh/en+api-scripting-support#generate-a-jwt-46). All Lotus APIs require authentication tokens to ensure your processes are as secure against attackers attempting to make unauthenticated requests to them.
Next, you will need to [create an authentication token](https://lotu.sh/en+api-scripting-support#generate-a-jwt-46). All Lotus APIs require authentication tokens to ensure your processes are as secure against attackers attempting to make unauthenticated requests to them.

### Connect the Lotus Worker

Expand Down
2 changes: 1 addition & 1 deletion documentation/en/mining-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ lotus-miner info
# WARN main lotus-storage-miner/main.go:73 failed to get api endpoint: (/Users/myrmidon/.lotusminer) %!w(*errors.errorString=&{API not running (no endpoint)}):
```

If you see this, that means your **Lotus Miner** isn't ready yet. You need to finish [syncing the chain](https://docs.lotu.sh/en+join-testnet).
If you see this, that means your **Lotus Miner** isn't ready yet. You need to finish [syncing the chain](https://lotu.sh/en+join-testnet).

## Error: Your computer may not be fast enough

Expand Down
6 changes: 3 additions & 3 deletions documentation/en/mining.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Storage Mining

Here are instructions to learn how to perform storage mining. For hardware specifications please read [this](https://docs.lotu.sh/en+hardware-mining).
Here are instructions to learn how to perform storage mining. For hardware specifications please read [this](https://lotu.sh/en+hardware-mining).

It is useful to [join the Testnet](https://docs.lotu.sh/en+join-testnet) prior to attempting storage mining for the first time.
It is useful to [join the Testnet](https://lotu.sh/en+join-testnet) prior to attempting storage mining for the first time.

## Note: Using the Lotus Miner from China

Expand All @@ -28,7 +28,7 @@ lotus wallet new bls

With your wallet address:

- Visit the [faucet](https://faucet.testnet.filecoin.io)
- Visit the [faucet](http://spacerace.faucet.glif.io/)
- Click "Create Miner"
- DO NOT REFRESH THE PAGE. THIS OPERATION CAN TAKE SOME TIME.

Expand Down
2 changes: 1 addition & 1 deletion documentation/en/retrieving-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Here are the operations you can perform after you have stored and sealed a **Data CID** with the **Lotus Miner** in the network.

If you would like to learn how to store a **Data CID** on a miner, read the instructions [here](https://docs.lotu.sh/en+storing-data).
If you would like to learn how to store a **Data CID** on a miner, read the instructions [here](https://lotu.sh/en+storing-data).

## Find by Data CID

Expand Down
2 changes: 1 addition & 1 deletion documentation/en/storing-data-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ In order to retrieve a file, it must be sealed. Miners can check sealing progres
lotus-miner sectors list
```

When sealing is complete, `pSet: NO` will become `pSet: YES`. From now on the **Data CID** is [retrievable](https://docs.lotu.sh/en+retrieving-data) from the **Lotus Miner**.
When sealing is complete, `pSet: NO` will become `pSet: YES`. From now on the **Data CID** is [retrievable](https://lotu.sh/en+retrieving-data) from the **Lotus Miner**.

0 comments on commit d8a669c

Please sign in to comment.