Skip to content
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

fix: installation instructions #2636

Merged
merged 4 commits into from
Jan 16, 2025
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
10 changes: 5 additions & 5 deletions ant-node-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ It runs on Linux, macOS and Windows.

## Installation

The latest version can be installed via [safeup](https://github.com/maidsafe/safeup):
The latest version can be installed via [antup](https://github.com/maidsafe/antup):
```
safeup antctl
antup antctl
```

A binary can also be obtained for your platform from the releases in this repository.
Expand Down Expand Up @@ -356,7 +356,7 @@ faucet - RUNNING

So by default, 25 node processes have been launched, along with a faucet. The faucet dispenses tokens for use when uploading files. We can now run `safe` commands against the local network.

The most common scenario for using a local network is for development, but you can also use it to exercise a lot of features locally. For more details, please see the 'Using a Local Network' section of the [main README](https://github.com/maidsafe/safe_network/tree/node-man-readme?tab=readme-ov-file#using-a-local-network).
The most common scenario for using a local network is for development, but you can also use it to exercise a lot of features locally. For more details, please see the 'Using a Local Network' section of the [main README](../README.md#using-a-local-network).

Once you've finished, run `antctl local kill` to dispose the local network.

Expand All @@ -366,9 +366,9 @@ Sometimes it will be necessary to run the integration tests in a local setup. Th

The tests can be run from a VM, which is provided by a `Vagrantfile` in the `ant_node_manager` crate directory. The machine is defined to use libvirt rather than Virtualbox, so an installation of that is required, but that is beyond the scope of this document.

Assuming that you did have an installation of libvirt, you can get the VM by running `vagrant up`. Once the machine is available, run `vagrant ssh` to get a shell session inside it. For running the tests, switch to the root user using `sudo su -`. As part of the provisioning process, the current `safe_network` code is copied to the root user's home directory. To run the tests:
Assuming that you did have an installation of libvirt, you can get the VM by running `vagrant up`. Once the machine is available, run `vagrant ssh` to get a shell session inside it. For running the tests, switch to the root user using `sudo su -`. As part of the provisioning process, the current `autonomi` code is copied to the root user's home directory. To run the tests:
```
cd safe_network
cd autonomi
just node-man-integration-tests
```

Expand Down
12 changes: 6 additions & 6 deletions ant-node-manager/src/bin/cli/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,7 @@ pub enum LocalSubCmd {
Join {
/// Set to build the antnode and faucet binaries.
///
/// This option requires the command run from the root of the safe_network repository.
/// This option requires the command run from the root of the autonomi repository.
#[clap(long)]
build: bool,
/// The number of nodes to run.
Expand Down Expand Up @@ -883,7 +883,7 @@ pub enum LocalSubCmd {
Run {
/// Set to build the antnode and faucet binaries.
///
/// This option requires the command run from the root of the safe_network repository.
/// This option requires the command run from the root of the autonomi repository.
#[clap(long)]
build: bool,
/// Set to remove the client data directory and kill any existing local network.
Expand Down Expand Up @@ -1364,18 +1364,18 @@ fn parse_environment_variables(env_var: &str) -> Result<(String, String)> {
async fn configure_winsw(verbosity: VerbosityLevel) -> Result<()> {
use ant_node_manager::config::get_node_manager_path;

// If the node manager was installed using `safeup`, it would have put the winsw.exe binary at
// If the node manager was installed using `antup`, it would have put the winsw.exe binary at
// `C:\Users\<username>\autonomi\winsw.exe`, sitting it alongside the other safe-related binaries.
//
// However, if the node manager has been obtained by other means, we can put winsw.exe
// alongside the directory where the services are defined. This prevents creation of what would
// seem like a random `autonomi` directory in the user's home directory.
let safeup_winsw_path = dirs_next::home_dir()
let antup_winsw_path = dirs_next::home_dir()
.ok_or_else(|| eyre!("Could not obtain user home directory"))?
.join("autonomi")
.join("winsw.exe");
if safeup_winsw_path.exists() {
ant_node_manager::helpers::configure_winsw(&safeup_winsw_path, verbosity).await?;
if antup_winsw_path.exists() {
ant_node_manager::helpers::configure_winsw(&antup_winsw_path, verbosity).await?;
} else {
ant_node_manager::helpers::configure_winsw(
&get_node_manager_path()?.join("winsw.exe"),
Expand Down
2 changes: 1 addition & 1 deletion ant-node/reactivate_examples/register_inspect.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
// //
// // The only want to avoid unwanted creation of a Register seems to
// // be to supply an empty wallet.
// // TODO Follow the issue about this: https://github.com/maidsafe/safe_network/issues/1308
// // TODO Follow the issue about this: https://github.com/maidsafe/autonomi/issues/1308
Dismissed Show dismissed Hide dismissed
// let root_dir = dirs_next::data_dir()
// .ok_or_else(|| eyre!("could not obtain data directory path".to_string()))?
// .join("autonomi")
Expand Down
2 changes: 1 addition & 1 deletion evmlib/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
homepage = "https://maidsafe.net"
license = "GPL-3.0"
name = "evmlib"
repository = "https://github.com/maidsafe/safe_network"
repository = "https://github.com/maidsafe/autonomi"
version = "0.1.8"

[features]
Expand Down
4 changes: 2 additions & 2 deletions resources/scripts/list-numbered-prs.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def main(pr_numbers):
pr_number = pr["number"]
closed_date = pr["closed_at"].date()
breaking_text = "[BREAKING]" if pr["breaking"] else ""
print(f"{closed_date} [#{pr_number}](https://github.com/maidsafe/safe_network/pull/{pr_number}) -- {pr['title']} [@{pr['author']}] {breaking_text}")
print(f"{closed_date} [#{pr_number}](https://github.com/maidsafe/autonomi/pull/{pr_number}) -- {pr['title']} [@{pr['author']}] {breaking_text}")

print()
grouped_pulls = defaultdict(list)
Expand Down Expand Up @@ -83,7 +83,7 @@ def main(pr_numbers):
pr_number = pr["number"]
closed_date = pr["closed_at"].date()
breaking_text = "[BREAKING]" if pr["breaking"] else ""
print(f" {closed_date} [#{pr_number}](https://github.com/maidsafe/safe_network/pull/{pr_number}) -- {pr['title']} {breaking_text}")
print(f" {closed_date} [#{pr_number}](https://github.com/maidsafe/autonomi/pull/{pr_number}) -- {pr['title']} {breaking_text}")
print()

def read_pr_numbers(file_path):
Expand Down
6 changes: 3 additions & 3 deletions resources/scripts/list-safe-network-closed-prs.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def main(last_released_pr_number):
raise Exception("The GITHUB_PAT_SAFE_NETWORK_PR_LIST environment variable must be set")

g = Github(token)
repo = g.get_repo("maidsafe/safe_network")
repo = g.get_repo("maidsafe/autonomi")

last_released_pr = repo.get_pull(last_released_pr_number)
if not last_released_pr:
Expand Down Expand Up @@ -64,7 +64,7 @@ def main(last_released_pr_number):
pr_number = pr["number"]
closed_date = pr["closed_at"].date()
breaking_text = "[BREAKING]" if pr["breaking"] else ""
print(f"{closed_date} [#{pr_number}](https://github.com/maidsafe/safe_network/pull/{pr_number}) -- {pr['title']} [@{pr['author']}] {breaking_text}")
print(f"{closed_date} [#{pr_number}](https://github.com/maidsafe/autonomi/pull/{pr_number}) -- {pr['title']} [@{pr['author']}] {breaking_text}")

print()
grouped_pulls = defaultdict(list)
Expand Down Expand Up @@ -98,7 +98,7 @@ def main(last_released_pr_number):
pr_number = pr["number"]
closed_date = pr["closed_at"].date()
breaking_text = "[BREAKING]" if pr["breaking"] else ""
print(f" {closed_date} [#{pr_number}](https://github.com/maidsafe/safe_network/pull/{pr_number}) -- {pr['title']} {breaking_text}")
print(f" {closed_date} [#{pr_number}](https://github.com/maidsafe/autonomi/pull/{pr_number}) -- {pr['title']} {breaking_text}")
print()


Expand Down
2 changes: 1 addition & 1 deletion resources/scripts/release-candidate-description.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def get_pr_list(pr_numbers):
pr_number = pr["number"]
closed_date = pr["closed_at"].date()
breaking_text = "[BREAKING]" if pr["breaking"] else ""
markdown_lines.append(f"{closed_date} [#{pr_number}](https://github.com/maidsafe/safe_network/pull/{pr_number}) -- {pr['title']} [@{pr['author']}] {breaking_text}")
markdown_lines.append(f"{closed_date} [#{pr_number}](https://github.com/maidsafe/autonomi/pull/{pr_number}) -- {pr['title']} [@{pr['author']}] {breaking_text}")
return markdown_lines


Expand Down
4 changes: 2 additions & 2 deletions resources/scripts/upload-random-data.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ fi
check_and_install_safe() {
if ! command -v safe &> /dev/null; then
echo "'safe' command not found. Installing..."
curl -sSL https://raw.githubusercontent.com/maidsafe/safeup/main/install.sh | sudo bash
safeup client
curl -sSL https://raw.githubusercontent.com/maidsafe/antup/main/install.sh | sudo bash
antup client
else
echo "'safe' command is already installed."
fi
Expand Down
2 changes: 1 addition & 1 deletion test-utils/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ homepage = "https://maidsafe.net"
license = "GPL-3.0"
name = "test-utils"
readme = "README.md"
repository = "https://github.com/maidsafe/safe_network"
repository = "https://github.com/maidsafe/autonomi"
version = "0.4.15"

[dependencies]
Expand Down
Loading