Giter VIP home page Giter VIP logo

bash-tool's Introduction

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!

!!!DO NOT USE UNTIL BUG FIXED!!!


Logo

ExploreNYM Bash Scripts

Supporting the installation and management of NYM nodes.

Table of Contents

  1. Languages
  2. About The Project
  3. Getting Started
  4. Usage
  5. Contributing
  6. License
  7. Contact

Languages available on the script

  • English
  • Português
  • Yкраїнська
  • Русский
  • Français

About The Project

Simple bash scripts to support community with the technical side of NYM infrastucture.

This is an attempt to make it a simple process as possible for anyone no matter there experience.

If you have any issues contact details below.

(back to top)

Getting Started

These scripts are only tested on ubuntu 20.04

Hardware Requirements

  • 1 cpu core
  • 0.5gb ram
  • 8gb storage space
  • ipv4 & ipv6 connection

Usage

Mixnode Tool

  1. Open a terminal in your local computer. (mac terminal) (windows shell)
  2. Connect to your server via ssh using your username and i.p example below.
  1. Intall git and jq on the server
sudo apt install git jq
  1. Copy and paste the script below into the server.
git clone https://github.com/ExploreNYM/bash-tool ~/bash-tool && ~/bash-tool/scripts/explore-nym.sh

if you are using this tool after already installing manually select migrate.

(back to top)

Contributing

We greatly appreciate any and all contributions to this project.

Contributing with NYM

If coding is not your thing you can support by delegating to our nodes.

  1. Indonesia: 4sxonGjdD4vNxWUvk8x8gCB7VpZgUBV4YDLg98oB4PUP
  2. Thailand: B9PJBmkT1gVNM4JSmhCa59Dj5aJ7vjk5uvuN5nbJKJW7
  3. Brazil: 2KuFi7CjKVh1mQrNKhdwLjhXBhVLRktvWMg5k4WXKdrX

We only accept donations to our nym wallet address below.

n1cvcmxmdgw39np3ft9duxj8vdfp9ktny6jtfc0r

Contributing with translations

Steps to translate the script to your language:

  1. Create your own Fork of the project.

image

  1. On your own Fork, edit the .json files inside the text folder. Add the json object with your language and only translate the values, not the keys. Follow the example below where pt-br was added:

image

  1. After you have added your translations create a pull request to add it to the script:

image

  1. After you create the pull request an automated validation script will check the integrity of the files you edited. If the test passes you're all good and your language will soon be added, If you didn't pass the automated test check the details to see what happened at which file and then correct it in order to pass the test.

Examples of pull requests failing:

image

  1. Details output when there's invalid syntax on one of the json files (invalid syntax on install.json in this case):

image

  1. Details output when there's extra or missing keys on one of the json files (extra key on install.json in this case):

image

  1. If you have conflicts with the base branch you should sync your fork similar to the way you created the pull request: image

  2. This is what it looks like if you pass the automated tests: image

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Twitter - @Pawnflake

Discord - Pawnflake

Discord - supermeia

Website - explorenym.net

bash-tool's People

Contributors

pawnflake avatar gabrielclcardoso avatar gorbanyok avatar nickshh1 avatar sven-hash avatar noisk8 avatar

Stargazers

 avatar  avatar  avatar Phoenix avatar  avatar Izabele Cabral avatar  avatar ⚡️2FakTor⚡️ avatar

Watchers

nox. avatar

bash-tool's Issues

Mixnode updates even when it's on the latest version

Description

When you try to update a mixnode with the tool it doesn't check if you're mixnode is already up to date. This causes the VPS to reset and the routing score of the mixnode to drop unnecessarily.

Invalid username breaks tool

Description

When you run the script as root you can choose to create a new user for your mixnode, if you try to create one but the creation fails the script tries to connect you to that new user, which is non existent, instead of telling you it failed and walking you through creating the new user again.

Steps to reproduce

1- Run the script as root
2- Chose yes when prompted to create a new sudo user
3- Enter an invalid username

Let the user choose the mixnode ID

Description

Currently the mixnode ID is set statically to nym-mixnode. Wouldn't it be better if the user could choose the ID of his mixnode?

CI for translations

Description
We want to make it so people can easily contribute through translations.

Solution
To achieve that we will create a small tutorial that people can use to understand how to contribute, and also setup github actions to check the integrity and contents of the json files

Add bonding to the script

Description
Currently the script leaves the bonding of the mixnode to be done by the user without any assistance.

Solution
It would be great if we could implement a way in which the bonding can happen through the script, making it so the person can fully setup the node through the script.

Alternatives
NYM has the nym-cli which could be used to do this.

Transfer text to JSON

Description
Currently all of the displayed text is hard coded into the script, and that makes it difficult to incorporate translation and bring accessibility to people who don't speak English

Solution
It would be great to have all the text that's printed by the script inside JSON files, this way we could just add languages by editing the JSON.

Additional context
This demand has come to our attention after the onboarding of many people from latin america on the delegations program and the future plans to expand the NYM network into places where people may not be familiar or feel comfortable with English.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.