mynode/doc/development.md

40 lines
1.7 KiB
Markdown
Raw Normal View History

2023-12-01 22:06:57 +00:00
# Developing for MyNode
2022-08-20 02:48:28 +00:00
## Loading Modified Software
2023-12-01 22:06:57 +00:00
Once you are running MyNode, you can easily modify and update the software yourself!
2022-08-20 02:48:28 +00:00
2023-12-01 22:06:57 +00:00
1. Start by running MyNode on your device via the instructions above in "Running MyNode"
2. Modify MyNode files
2022-08-20 02:48:28 +00:00
* Clone this git repo on your PC or laptop - `git clone https://github.com/mynodebtc/mynode.git`
* Make your modifications
3. Run `make rootfs`
* Or run `make rootfs_auto` in a new console tab
* This will automatically create artifacts as local files are modified
4. Run 'make start_file_server'
* This will run a local HTTP server so your device can download files
5. On your device, run `sudo mynode-local-upgrade [dev pc ip address]`
* This will download your locally generated artifact and install it on your device
* Your device will automatically reboot to ensure updates take effect
6. Test your changes!
7. Submit Pull Request to share your updates!
### To update a subsystem without rebooting
Add another argument to the local upgrade script:
- To update files only, run `sudo mynode-local-upgrade [dev pc ip address] files`
- To update files and restart web server, run `sudo mynode-local-upgrade [dev pc ip address] www`
2023-12-01 22:06:57 +00:00
## Setup new device to run MyNode
2022-08-20 02:48:28 +00:00
This steps will setup a new device and can be used for making images. These steps allow for updates to the `setup_device.sh` script that does the initial install.
1. Run make command for your device. Ex:
* `make setup_new_rock64`
* `make setup_new_rockpro64`
* `make setup_new_raspi3`
* `make setup_new_raspi4`
2024-01-08 00:56:18 +00:00
* `make setup_new_raspi5`
2022-08-20 02:48:28 +00:00
* `make setup_new_debian`
* `make setup_new_other`
3. Follow Instructions
2. Reboot Device
2023-12-01 22:06:57 +00:00
4. Congratulations! You're running a new MyNode device!