README.md (2563B)
1 # Gluon Remote 2 3 A tool to easily manage Freifunk Gluon Routers. (WIP) 4 5 Discussion Thread: https://forum.freifunk.net/t/gluon-remote-tool/ 6 7 ## Getting Started 8 9 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. 10 11 ### Prerequisities 12 13 What things you need to install the software and how to install them 14 15 ``` 16 1. Install the Linux Package 'ssh-keygen' 17 2. clone the repository to anywhere you want 18 3. Edit the config/config.json file as your needs 19 ``` 20 21 ### Running 22 23 A step by step series of how to run the App 24 25 Web: 26 27 ``` 28 Web isn't implemented yet. 29 ``` 30 31 Commandline: 32 33 ``` 34 Usage: npm start [options] [command] 35 36 SSH Key has to be a private one. It is used to connect to the Router which means that you have to have a private key for the Tool and the public one must be registered in the Router 37 38 Commands: 39 40 changeName <ip> <ssh> [token] <newname> Change the Hostname of the router (no Formular support yet!) 41 changeContact <ip> <ssh> [token] [ccode] <name> <email> Change the Contact of the router (no Formular support yet!) 42 changeGeo <ip> <ssh> [token] [ccode] <lat> <long> <altitude> Change the Router Position (no Formular support yet!) 43 MOL <ip> <ssh> <on/off> Activate or deactivate Mesh on Lan 44 MOW <ip> <ssh> <on/off> Activate or deactivate Mesh on Wan 45 help [cmd] display help for [cmd] 46 47 Options: 48 49 -h, --help output usage information 50 51 ``` 52 53 ## Running the tests 54 55 Test's not implemented yet 56 57 ## Built With 58 59 * Commander - Commandline commands 60 * Expressjs - Web Server 61 * ssh-keygen - Genearating SSH-keys if needed 62 * sshclient - Libary for connecting Router over SSH 63 64 [//]: # (## Contributing) 65 66 [//]: # (Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.) 67 68 ## Versioning 69 70 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/MTRNord/gluon_remote_node/tags). 71 72 ## Authors 73 74 * **MTRNord** - *Initial work* - [MTRNord](https://github.com/MTRNord) 75 76 See also the list of [contributors](https://github.com/MTRNord/gluon_web_remote_node/contributors) who participated in this project. 77 78 ## License 79 80 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details