-
Notifications
You must be signed in to change notification settings - Fork 69
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
Add 2 new pages #144
Open
gekomod
wants to merge
10
commits into
openmediavault:master
Choose a base branch
from
gekomod:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add 2 new pages #144
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
3dc7de0
Create plugins-build-plugin.md
gekomod 310d0a9
test
gekomod 146c176
Test
gekomod e8d645d
Add Next File
gekomod 9a5ef92
Update .gitignore
gekomod b0e49ce
del
gekomod f3ba25f
change md to rst
gekomod aa5c91b
Fix
gekomod 22ca517
RollBack
gekomod 6581ef1
Update docker-compose-example-list.rst
gekomod File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
Plugin Development | ||
=========================== | ||
|
||
Create Row Container List - File Structure | ||
------------------------------------------ | ||
|
||
.. code:: tree | ||
|
||
└──ContainerName | ||
├──ContainerName.env | ||
├──ContainerName.yml | ||
├──Containername - This is icon | ||
└──readme | ||
|
||
ContainerName.env | ||
----------------- | ||
|
||
.. code:: env | ||
|
||
Various Options | ||
|
||
ContainerName.yml | ||
----------------- | ||
|
||
Example based on the radarr.yml file | ||
|
||
.. code:: yml | ||
|
||
--- | ||
services: | ||
radarr: | ||
image: lscr.io/linuxserver/radarr:latest | ||
container_name: radarr | ||
environment: | ||
- PUID=1000 | ||
- PGID=100 | ||
- TZ=Europe/Istanbul | ||
volumes: | ||
- CHANGE_TO_COMPOSE_DATA_PATH/radarr/config:/config | ||
- CHANGE_TO_COMPOSE_DATA_PATH/radarr/movies:/movies | ||
- CHANGE_TO_COMPOSE_DATA_PATH/radarr/downloads:/downloads | ||
ports: | ||
- 7878:7878 | ||
restart: unless-stopped | ||
|
||
Readme | ||
------ | ||
|
||
.. code:: readme | ||
|
||
Container description | ||
|
||
Icon | ||
---- | ||
|
||
The icon should be downloaded to the container directory, i.e. | ||
|
||
ContainerName/ContainerName | ||
|
||
The icon must be without an ending, i.e. without .png .jpg .svg .bmp | ||
etc. | ||
|
||
Pull Request | ||
------------ | ||
|
||
Upload the finished files to Github | ||
(https://github.com/OpenMediaVault-Plugin-Developers/packages) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,5 @@ Development | |
howitworks | ||
tools/index | ||
plugins | ||
plugins-build-plugin | ||
docker-compose-example-list |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
Files and directory | ||
=================== | ||
|
||
Tree files and directory | ||
------------------------ | ||
|
||
Type Files: | ||
|
||
- FILETYPE | ||
|
||
1. network | ||
2. storage | ||
3. services | ||
4. usermgmt | ||
5. diagnostics | ||
|
||
.. code:: shell | ||
|
||
|
||
├── DEBIAN | ||
│ ├── changelog | ||
│ ├── compat | ||
│ ├── control | ||
│ ├── copyright | ||
│ ├── install | ||
│ ├── postinst | ||
│ ├── postrm | ||
│ ├── rules | ||
│ └── triggers | ||
└── usr | ||
├── sbin | ||
│ └── plugin-file-name | ||
└── share | ||
└── openmediavault | ||
├── confdb | ||
│ └── create.d | ||
│ └── conf.system.network.PLUGINNAME.sh | ||
├── datamodels | ||
│ └── conf.system.network.PLUGINNAME.json | ||
├── engined | ||
│ ├── inc | ||
│ │ └── PLUGINNAME.inc # LogFileSpec | ||
│ ├── module | ||
│ │ └── PLUGINNAME.inc | ||
│ └── rpc | ||
│ └── PLUGINNAME.inc | ||
├── locale | ||
│ ├── openmediavault-PLUGINNAME.pot | ||
│ ├── pl | ||
│ │ └── openmediavault-PLUGINNAME.po | ||
│ └── pl_PL | ||
│ └── openmediavault-PLUGINNAME.po | ||
└── workbench | ||
├── component.d | ||
│ ├── omv-network-PLUGINNAME-form-page.yaml | ||
│ ├── omv-network-PLUGINNAME-navigation-page.yaml | ||
│ └── omv-network-PLUGINNAME-noip-form-page.yaml | ||
├── log.d | ||
│ └── PLUGINNAME.yaml | ||
├── navigation.d | ||
│ └── network.PLUGINNAME.yaml | ||
└── route.d | ||
└── network.PLUGINNAME.yaml | ||
|
||
Files | ||
----- | ||
|
||
rpc | ||
~~~ | ||
|
||
``PLUGINNAME.inc`` | ||
|
||
.. code:: php | ||
|
||
<?php | ||
|
||
#SET NAME filetypePluginame example - ServicesExample | ||
class ServicesExample extends \OMV\Rpc\ServiceAbstract { | ||
|
||
#SET NAME filetypePluginame example - ServicesExample | ||
public function getName() { | ||
return "NAME"; | ||
} | ||
|
||
|
||
#Register Method to use function | ||
public function initialize() { | ||
$this->registerMethod('getSettings'); | ||
$this->registerMethod('setSettings'); | ||
} | ||
} | ||
?> | ||
|
||
debian | ||
~~~~~~ | ||
|
||
``changelog`` | ||
|
||
``control`` - Set name and author plugin | ||
|
||
``postinst`` - Creating a database, directories, and installing the | ||
necessary libraries you need | ||
|
||
``postrm`` - Code used when uninstalling a plugin | ||
|
||
workbench | ||
~~~~~~~~~ | ||
|
||
Datatable Example | ||
----------------- | ||
|
||
.. code:: yaml | ||
|
||
version: "1.0" | ||
type: component | ||
data: | ||
name: omv-services-example-file-form-page | ||
type: datatablePage | ||
config: | ||
autoReload: false | ||
hasSearchField: true | ||
rowId: name | ||
sorters: | ||
- dir: asc | ||
prop: name | ||
store: | ||
proxy: | ||
service: Example | ||
get: | ||
method: getExampleList //GET ROWS FROM rpc | ||
columns: | ||
- name: " " | ||
prop: image | ||
flexGrow: 0.15 | ||
cellTemplateName: image | ||
cellTemplateConfig: | ||
class: "mat-icon notranslate mat-icon-no-color" | ||
alt: " " | ||
src: "{{ image }}" | ||
- name: _("Name") | ||
prop: name | ||
flexGrow: 1 | ||
sortable: true | ||
actions: | ||
- type: iconButton | ||
icon: mdi:plus-box | ||
tooltip: _("Add example file") | ||
enabledConstraints: | ||
minSelected: 1 | ||
maxSelected: 1 | ||
execute: | ||
type: formDialog | ||
formDialog: | ||
title: _("Add...") | ||
fields: | ||
- type: textInput | ||
name: name | ||
label: _("Name") | ||
value: "{{ _selected[0].name }}" | ||
- type: textInput | ||
name: description | ||
label: _("Description") | ||
value: "" | ||
buttons: | ||
submit: | ||
text: _("Add") | ||
execute: | ||
type: request | ||
request: | ||
service: Example | ||
method: setExample | ||
progressMessage: _("Adding an example ...") | ||
successNotification: _("Example has been added.") | ||
successUrl: /services/example/files | ||
|
||
Form | ||
---- | ||
|
||
- NO INFORMATION | ||
|
||
Database write and read | ||
----------------------- | ||
|
||
- NO INFORMATION | ||
|
||
Bash executables | ||
---------------- | ||
|
||
- NO INFORMATION | ||
|
||
Generating the deb file and installing | ||
-------------------------------------- | ||
|
||
.. code:: shell | ||
|
||
cd openmediavault-pluginame | ||
dpkg-buildpackage -us -uc | ||
|
||
``Install`` | ||
|
||
.. code:: shell | ||
|
||
dpkg -i openmediavault-pluginname_VERSION_all.deb |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't it make sense to move that into under
Development > Plugin Development
?A short introduction that describes what this chapter is about would be helpful for the users to understand what they are watching here.