[GH-ISSUE #47] Documentation a bit...lacking? #45

Closed
opened 2026-02-26 17:44:07 +03:00 by kerem · 9 comments
Owner

Originally created by @PracticalChip on GitHub (Apr 24, 2021).
Original GitHub issue: https://github.com/Corsinvest/cv4pve-autosnap/issues/47

First I tried cv4pve-tools, then toolbox because after spending HOURS in the cli setting up proxmox and migrating a bunch of VM's I just really wanted something NOT in the cli...

However, this feedback is for all of it.

It goes from the install to configuring backups, nothing about the actual setting up of the tool, how to get your license key, the "IMSI IP" and the "IP" token formatting(an example of how your application wants it implemented would be nice), none of it.

I went to the resources tab on your website and there is nothing, just a broken link, I went to the documentation tab, and it just shows you how to install it.

I have tried to get all that working 4 times now, I just keep wiping the docker containers, when I put in the wrong information(i guess?), the application completely error's out and won't even let me restore backup to try again. I keep having to wipe and reinstall. After 4 times...I'm just done.

And yes I know there is a premium option for support, but spending that time just fiddling with it on a home lab to consider trying to sell it to my workplace is....I'd rather just use Veeam.

I know I am a bit frustrated right now, and I don't mean to sound standoffish, but I guess my feedback is the documentation needs a serious overhaul.

Originally created by @PracticalChip on GitHub (Apr 24, 2021). Original GitHub issue: https://github.com/Corsinvest/cv4pve-autosnap/issues/47 First I tried cv4pve-tools, then toolbox because after spending HOURS in the cli setting up proxmox and migrating a bunch of VM's I just really wanted something NOT in the cli... However, this feedback is for all of it. It goes from the install to configuring backups, nothing about the actual setting up of the tool, how to get your license key, the "IMSI IP" and the "IP" token formatting(an example of how your application wants it implemented would be nice), none of it. I went to the resources tab on your website and there is nothing, just a broken link, I went to the documentation tab, and it just shows you how to install it. I have tried to get all that working 4 times now, I just keep wiping the docker containers, when I put in the wrong information(i guess?), the application completely error's out and won't even let me restore backup to try again. I keep having to wipe and reinstall. After 4 times...I'm just done. And yes I know there is a premium option for support, but spending that time just fiddling with it on a home lab to _consider_ trying to sell it to my workplace is....I'd rather just use Veeam. I know I am a bit frustrated right now, and I don't mean to sound standoffish, but I guess my feedback is the documentation needs a serious overhaul.
kerem closed this issue 2026-02-26 17:44:07 +03:00
Author
Owner

@franklupo commented on GitHub (Apr 24, 2021):

hi, sorry for your frustration. I would like to understand better what problem you encountered. I would like to help you. Can you help me understand where you find problems?

<!-- gh-comment-id:826150444 --> @franklupo commented on GitHub (Apr 24, 2021): hi, sorry for your frustration. I would like to understand better what problem you encountered. I would like to help you. Can you help me understand where you find problems?
Author
Owner

@PracticalChip commented on GitHub (Apr 24, 2021):

hi, sorry for your frustration. I would like to understand better what problem you encountered. I would like to help you. Can you help me understand where you find problems?

Thanks for the prompt and polite response, I have a looooot of work things to do over the weekend(heh...it would be nice to get time off.), So I'll go over it on Monday and give you a full explanation of what I did/may have done wrong and then give you a full writeup. I'll also just make a snapshot in proxmox and restore it to get more information instead of using the built in restore for now, should make it simpler.

Once again apologies for any attitude I may have seem to have had...it was...a very long day haha.

<!-- gh-comment-id:826150862 --> @PracticalChip commented on GitHub (Apr 24, 2021): > hi, sorry for your frustration. I would like to understand better what problem you encountered. I would like to help you. Can you help me understand where you find problems? Thanks for the prompt and polite response, I have a looooot of work things to do over the weekend(heh...it would be nice to get time off.), So I'll go over it on Monday and give you a full explanation of what I did/may have done wrong and then give you a full writeup. I'll also just make a snapshot in proxmox and restore it to get more information instead of using the built in restore for now, should make it simpler. Once again apologies for any attitude I may have seem to have had...it was...a very long day haha.
Author
Owner

@franklupo commented on GitHub (Apr 24, 2021):

I'm here to troubleshoot. if something is wrong and why I made a mistake I have not explained well how it must be done. See you soon. Thanks

<!-- gh-comment-id:826151704 --> @franklupo commented on GitHub (Apr 24, 2021): I'm here to troubleshoot. if something is wrong and why I made a mistake I have not explained well how it must be done. See you soon. Thanks
Author
Owner

@franklupo commented on GitHub (Apr 27, 2021):

News?

<!-- gh-comment-id:827850249 --> @franklupo commented on GitHub (Apr 27, 2021): News?
Author
Owner

@PracticalChip commented on GitHub (Apr 27, 2021):

Sorry was super busy yesterday and today, got hit with an emergency
project, I'll get on it tomorrow 100%

On Tue, Apr 27, 2021 at 2:10 PM, Daniele Corsini @.***>
wrote:

News?


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/Corsinvest/cv4pve-autosnap/issues/47#issuecomment-827850249,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AKOEZFY2BO2TKB7DMPAN66TTK4D25ANCNFSM43PVUJWA
.

<!-- gh-comment-id:827889719 --> @PracticalChip commented on GitHub (Apr 27, 2021): Sorry was super busy yesterday and today, got hit with an emergency project, I'll get on it tomorrow 100% On Tue, Apr 27, 2021 at 2:10 PM, Daniele Corsini ***@***.***> wrote: > News? > > — > You are receiving this because you authored the thread. > Reply to this email directly, view it on GitHub > <https://github.com/Corsinvest/cv4pve-autosnap/issues/47#issuecomment-827850249>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AKOEZFY2BO2TKB7DMPAN66TTK4D25ANCNFSM43PVUJWA> > . >
Author
Owner

@franklupo commented on GitHub (Apr 27, 2021):

no problem!

<!-- gh-comment-id:827911411 --> @franklupo commented on GitHub (Apr 27, 2021): no problem!
Author
Owner

@PracticalChip commented on GitHub (Apr 28, 2021):

I found the problem actually!

[image: Screenshot 2021-04-28 143042.png]
So the issue was the api token format wasnt clear, I set

AUTOSNAPSHOT@PVE!BACKUPS!Tokenid=asdfghjkl-1234568799-qwertytuyi

instead of the correct way which is

@.***!backups=asdfghjkl-1234568799-qwertytuyi

With the Equals there I thought it was like a tokenid=apikey instead of the
literal meaning of backups(tokenid)=1234568799-qwertytuyi(api token)

so I just added an exclamation point to it.

So yeah the instructions werent terribly clear, but i did figure it out
this time.

my recommendation would be to just be a tid bit more verbose on the
installation bit.

Also when you put that information in wrong it completely critically
error's the application out so you need to use a snapshot to restore it to
its pre-saved state.

Restoring from your internal restore system does not fix it. you have to
completely remove the docker container and rebuild the system to do it in
any short order.

Also:

FE15FE14-5214-479F-8131-35A91E84C750

The IP address and the IPMI address...there should be a note above it
pointing out that it's for proxmox. I was confused about the IPMI as
technically the cv4-pvetools is an ipmi...it manages and monitors the
proxmox backups...so you can understand my confusion there.

I actually kind of just guessed this time.

outside of that

50F3F2B3-957B-48B9-9D0D-1854D8ACBE1F

I know you have "login toolbox" above that however, might I recommend
bolding those "login" portions to highlight that it's a section and you
don't need the toolbox ssh?

I thought this was a much bigger problem than I was having and I do
apologise for causing a stir, however small usability changes that I have
recommended could possibly stop this from happening in the future.

On Tue, Apr 27, 2021 at 3:34 PM Daniele Corsini @.***>
wrote:

no problem!


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/Corsinvest/cv4pve-autosnap/issues/47#issuecomment-827911411,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AKOEZF2FEPGW6DKH33SYRC3TK4NWNANCNFSM43PVUJWA
.

<!-- gh-comment-id:828729056 --> @PracticalChip commented on GitHub (Apr 28, 2021): I found the problem actually! [image: Screenshot 2021-04-28 143042.png] So the issue was the api token format wasnt clear, I set AUTOSNAPSHOT@PVE!BACKUPS!Tokenid=asdfghjkl-1234568799-qwertytuyi instead of the correct way which is ***@***.***!backups=asdfghjkl-1234568799-qwertytuyi With the Equals there I thought it was like a tokenid=apikey instead of the literal meaning of backups(tokenid)=1234568799-qwertytuyi(api token) so I just added an exclamation point to it. So yeah the instructions werent terribly clear, but i did figure it out this time. my recommendation would be to just be a tid bit more verbose on the installation bit. Also when you put that information in wrong it completely critically error's the application out so you need to use a snapshot to restore it to its pre-saved state. Restoring from your internal restore system does not fix it. you have to completely remove the docker container and rebuild the system to do it in any short order. Also: ![FE15FE14-5214-479F-8131-35A91E84C750](https://user-images.githubusercontent.com/43797655/116465026-4edefd80-a832-11eb-955b-c229f24a6705.png) The IP address and the IPMI address...there should be a note above it pointing out that it's for proxmox. I was confused about the IPMI as technically the cv4-pvetools is an ipmi...it manages and monitors the proxmox backups...so you can understand my confusion there. I actually kind of just guessed this time. outside of that ![50F3F2B3-957B-48B9-9D0D-1854D8ACBE1F](https://user-images.githubusercontent.com/43797655/116465071-5d2d1980-a832-11eb-942d-3366140f04b9.png) I know you have "login toolbox" above that however, might I recommend bolding those "login" portions to highlight that it's a section and you don't need the toolbox ssh? I thought this was a much bigger problem than I was having and I do apologise for causing a stir, however small usability changes that I have recommended could possibly stop this from happening in the future. On Tue, Apr 27, 2021 at 3:34 PM Daniele Corsini ***@***.***> wrote: > no problem! > > — > You are receiving this because you authored the thread. > Reply to this email directly, view it on GitHub > <https://github.com/Corsinvest/cv4pve-autosnap/issues/47#issuecomment-827911411>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AKOEZF2FEPGW6DKH33SYRC3TK4NWNANCNFSM43PVUJWA> > . >
Author
Owner

@franklupo commented on GitHub (Apr 28, 2021):

Hello,
I don't see the attached images. If you want to send me the texts you think are most appropriate to add.

Thanks again

<!-- gh-comment-id:828736822 --> @franklupo commented on GitHub (Apr 28, 2021): Hello, I don't see the attached images. If you want to send me the texts you think are most appropriate to add. Thanks again
Author
Owner

@PracticalChip commented on GitHub (Apr 28, 2021):

Hello,
I don't see the attached images. If you want to send me the texts you think are most appropriate to add.

Thanks again

Sorry I added images to the original one, I had responded via email, not via GitHub. That should take care of it!

<!-- gh-comment-id:828739384 --> @PracticalChip commented on GitHub (Apr 28, 2021): > Hello, > I don't see the attached images. If you want to send me the texts you think are most appropriate to add. > > Thanks again Sorry I added images to the original one, I had responded via email, not via GitHub. That should take care of it!
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/cv4pve-autosnap#45
No description provided.