Skip to content
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

restic rest-server 0.12.1 initial package #5550

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

fgma
Copy link
Contributor

@fgma fgma commented Jan 4, 2023

Description

New package for restic's rest-server:

https://restic.net/
https://github.com/restic/rest-server

Checklist

  • Build rule all-supported completed successfully
  • New installation of package completed successfully
  • Package upgrade completed successfully (Manually install the package again)
  • Package functionality was tested
  • Any needed documentation is updated/created

Type of change

  • Bug fix
  • New Package
  • Package update
  • Includes small framework changes
  • This change requires a documentation update (e.g. Wiki)

TODO:

@fgma
Copy link
Contributor Author

fgma commented Jan 5, 2023

I will add the port to the wiki when I got some feedback if this PR is getting accepted and the port is OK to be used.

I don't use the certificate handling myself but I guess this would be a nice feature for others. Would the syncthing implementation be a good starting point or is this not yet stable enough yet?

cross/rest-server/Makefile Outdated Show resolved Hide resolved
cross/rest-server/Makefile Outdated Show resolved Hide resolved
cross/rest-server/Makefile Outdated Show resolved Hide resolved
@hgy59
Copy link
Contributor

hgy59 commented Jan 5, 2023

just added some suggestions.

Another suggestion for the wizard:
You could use one multiselect item instead of single select to have individual checkboxes for each option (and not two check boxes for each).

You can find an example in matrix-synapse PR #5399 (this one uses two multiselect items to have additional description for each option, but as you don't have an additional description you can use one multiselect with multiple subitems)

@fgma
Copy link
Contributor Author

fgma commented Jan 5, 2023

I've switched to multiselect. It looks a bit nicer and the internal handling is a bit easier.

@fgma
Copy link
Contributor Author

fgma commented Mar 5, 2023

Updated to current master. Anything else left for me to do here?

@fetzerch
Copy link

Thanks much for packaging this! I have been using restic-rest-server already a couple of months on a Synology box with a manual deployment. I now tried the package built in CI and it seems to work fine. Really looking forward to get this PR integrated.

I had to tweak two things manually to better support my usecase. Wanted to bring them up for discussion to see if it makes sense to include them as UI settings.

  1. I'm backing up to an external USB drive, but I could not select volumeUSB1 in the wizard. I was able to change that in /usr/syno/etc/packages/restic-rest-server/installer-variables.
  2. I'm using https with a self signed certificate (public_key and private_key files are located in the backup repository root) and therefore I had to modify /var/packages/restic-rest-server/scripts/service-setup to start the service with --tls. It would be nice if there was an extra field in the wizard to add 'custom' options.

@hgy59
Copy link
Contributor

hgy59 commented Mar 11, 2023

2. I'm using https with a self signed certificate (public_key and private_key files are located in the backup repository root) and therefore I had to modify /var/packages/restic-rest-server/scripts/service-setup to start the service with --tls. It would be nice if there was an extra field in the wizard to add 'custom' options.

This triggers the discussion above to add a file for custom service arguments.

@hgy59
Copy link
Contributor

hgy59 commented Mar 11, 2023

Updated to current master. Anything else left for me to do here?

see #5649 for shared folder handling.

probably this will solve the use case to use an usb drive for backups (when creating a shared folder on the usb drive before the installation of restic rest-server and chosing this share in the wizard).

@fgma
Copy link
Contributor Author

fgma commented Mar 12, 2023

I'll add support for additional custom arguments.

Concerning the certificates: Shouldn't we use SERVICE_CERT/SERVICE_CERT_RELOAD for this use case?

@hgy59
Copy link
Contributor

hgy59 commented Mar 12, 2023

Concerning the certificates: Shouldn't we use SERVICE_CERT/SERVICE_CERT_RELOAD for this use case

Does this work for DSM 6 only? #5117 and #5118

@fgma
Copy link
Contributor Author

fgma commented Mar 12, 2023

I have no idea. I don't use it. I've just read about it in the documentation and thought this the proper way to handle certificates.

@fgma
Copy link
Contributor Author

fgma commented Mar 15, 2023

Custom arguments added. What about certificate handling? Is there an official way to do so?

@hgy59 hgy59 added the new-package PR/WIP for a new package label Apr 7, 2023
@fgma fgma changed the title restic rest-server 0.11.0 initial package restic rest-server 0.12.0 initial package Apr 24, 2023
@fgma fgma changed the title restic rest-server 0.12.0 initial package restic rest-server 0.12.1 initial package Jul 17, 2023
@fgma fgma requested a review from hgy59 August 17, 2023 19:50
@fetzerch
Copy link

Any chance you could retrigger a build, I would like to try it out using the packages (but they're gone).

@hgy59
Copy link
Contributor

hgy59 commented Jan 21, 2024

@fgma can you repase this PR?
It is not possible to trigger the gh-build-action again.

Comment on lines +24 to +25
SERVICE_WIZARD_SHARE = wizard_data_directory
USE_DATA_SHARE_WORKER = yes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the new version for shared folders:

define SERVICE_WIZARD_SHARE_NAME
and remove SERVICE_WIZARD_SHARE and USE_DATA_SHARE_WORKER
and remove the volume configuration in the install and uninstall wizards (use the share name only in the install and uninstall wizard)

@fgma fgma force-pushed the restic-rest-server branch from 77dfef0 to 05dadc4 Compare February 26, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-package PR/WIP for a new package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants