Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owenvoke/readynas
A PHP management suite for ReadyNAS devices.
https://github.com/owenvoke/readynas
composer nas php7 readynas readynas-devices
Last synced: about 1 month ago
JSON representation
A PHP management suite for ReadyNAS devices.
- Host: GitHub
- URL: https://github.com/owenvoke/readynas
- Owner: owenvoke
- License: mit
- Created: 2017-10-05T17:24:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-05T09:09:54.000Z (over 5 years ago)
- Last Synced: 2024-11-16T14:14:11.322Z (about 2 months ago)
- Topics: composer, nas, php7, readynas, readynas-devices
- Language: PHP
- Homepage: https://packagist.org/packages/pxgamer/readynas
- Size: 92.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# readynas
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-styleci]][link-styleci]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
A PHP management suite for ReadyNAS devices.
## Structure
```
src/
tests/
vendor/
```
## Install
Via Composer
``` bash
$ composer require pxgamer/readynas
```
## Usage
All that needs to be done, is to set the environment variables.
`NAS_HOST` - The IP/domain of the NAS
`NAS_USER` - The username to connect to your NAS with
`NAS_PASS` - The password to connect to your NAS with
Environment variables can be defined in multiple ways.
- Using a `.env` file via [`vlucas/phpdotenv`][link-vlucas/phpdotenv]
- Using the `export` command on Unix
- Using the `setx` command on Windows
## Compatibility
System | Firmware | Status
------------ | -------- | -------
ReadyNAS 102 | 6.7+ | ✓
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [pxgamer][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/pxgamer/readynas.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/pxgamer/readynas/master.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/105919114/shield
[ico-code-quality]: https://img.shields.io/codecov/c/github/pxgamer/readynas.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/pxgamer/readynas.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/pxgamer/readynas
[link-travis]: https://travis-ci.org/pxgamer/readynas
[link-styleci]: https://styleci.io/repos/105919114
[link-code-quality]: https://codecov.io/gh/pxgamer/readynas
[link-downloads]: https://packagist.org/packages/pxgamer/readynas
[link-author]: https://github.com/pxgamer
[link-contributors]: ../../contributors
[link-vlucas/phpdotenv]: https://packagist.org/packages/vlucas/phpdotenv