Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rajch committed Jul 19, 2024
1 parent b0477a2 commit 32ad2a1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ReWeave - an effort to keep Weave Net alive
# Weave Net

This repository contains a fork of Weave Net, the first product developed by Weaveworks. Since Weaveworks has shut down, this repo aims to continue maintaining Weave Net, and to publish releases regularly.

Expand All @@ -7,7 +7,7 @@ This repository contains a fork of Weave Net, the first product developed by Wea
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rajch/weave?include_prereleases)](https://github.com/rajch/weave/releases)
[![Unique CVE count in all images](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Frajch%2Fweave%2Fmaster%2Freweave%2Fscans%2Fbadge.json&label=CVE%20count "The number of unique CVEs reported by scanning all images")](reweave/scans/report.md)

The history of the ReWeave effort can be found in [HISTORY.md](HISTORY.md).
The history of the fork can be found in [HISTORY.md](HISTORY.md).

## Using Weave Net on Kubernetes

Expand Down
20 changes: 16 additions & 4 deletions website/install/installing-weave.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,28 @@ Install Weave Net by running the following:
sudo curl -L https://reweave.azurewebsites.net/get-weave -o /usr/local/bin/weave
sudo chmod a+x /usr/local/bin/weave

~~If you are on OSX and you are using Docker Machine ensure that a VM is running and configured
The URL https://reweave.azurewebsites.net/get-weave, is provided by the companion project [weave-endpoint](https://github.com/rajch/weave-endpoint). You can also fetch a particular version of Weave Net by specifying a `?version=` query string, like this:

sudo curl -L https://reweave.azurewebsites.net/get-weave -o /usr/local/bin/weave?version=v2.8.3

Supported versions start from 2.8.2, the first release since forking from weaveworks/weave.

> **Note:** The following information is obsolete, and included only for historical reference.
>
> If you are on OSX and you are using Docker Machine ensure that a VM is running and configured
before downloading Weave Net. To set up a VM see [the Docker Machine
documentation](https://docs.docker.com/installation/mac/#from-your-shell) or refer to ["Part 1: Launching Weave Net with Docker Machine"](https://web.archive.org/web/20231002233731/https://www.weave.works/guides/part-1-launching-weave-net-with-docker-machine/).

After your VM is setup with Docker Machine, Weave Net can be launched directly from the OSX host.~~
>
> After your VM is setup with Docker Machine, Weave Net can be launched directly from the OSX host.
Weave Net respects the environment variable `DOCKER_HOST`, so that you can run and control a Weave Network locally on a remote host. See [Using The Weave Docker API Proxy]({{ '/tasks/weave-docker-api/using-proxy' | relative_url }}).

With Weave Net downloaded onto your VMs or hosts, you are ready to launch a Weave network and deploy apps onto it. See [Launching Weave Net]({{ '/install/using-weave' | relative_url }}).

### Quick Start Screencast

> **Note:** The screencast uses an old download URL, `https://git.io/weave`. This still serves an old version of Weave Net, and should not be used any more. Instead, `https://reweave.azurewebsites.net/get-weave` should be used.
<a href="https://youtu.be/kihQCCT1ykE" target="_blank">
<img src="hello-screencast.png" alt="Click to watch the screencast" />
</a>
Expand All @@ -48,7 +58,7 @@ To disable this check, run the following before launching Weave Net:

export CHECKPOINT_DISABLE=1

**Note:** Weaveworks does not maintain these servers any more. Weave Net will make the call and silently fail. This will not affect normal operations. Still, it is recommended to set the `CHECKPOINT_DISABLE` variable as shown above. This feature will be removed from the community-supported Weave Net in the near future.
> **Note:** Weaveworks does not maintain these servers any more. Weave Net will make the call and silently fail. This will not affect normal operations. Still, it is recommended to set the `CHECKPOINT_DISABLE` variable as shown above. Starting from v2.8.2, the `CHECKPOINT_DISABLE` variable is set by default. This feature will be removed from the community-supported Weave Net in the near future.
### Guides for Specific Platforms

Expand All @@ -64,6 +74,8 @@ full speed of the underlying network.
To make encryption in fast datapath work on Google Cloud Platform, see
[here]({{ '/faq#ports' | relative_url }}).

> **Note:** The community that currently maintains Weave Net lacks the manpower and resources to support specific platforms at the moment. We would welcome any help.
**See Also**

* [Launching Weave Net]({{ '/install/using-weave' | relative_url }})
Expand Down

0 comments on commit 32ad2a1

Please sign in to comment.