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

Portable Kiwix, allow to custom all local storage/configuration locations #1166

Closed
kelson42 opened this issue Aug 1, 2024 · 5 comments · Fixed by #1179
Closed

Portable Kiwix, allow to custom all local storage/configuration locations #1166

kelson42 opened this issue Aug 1, 2024 · 5 comments · Fixed by #1179
Assignees
Milestone

Comments

@kelson42
Copy link
Collaborator

kelson42 commented Aug 1, 2024

In a case of a portable Kiwix (running on a portable USB drive for example), we want to keep everything local on USB drive. We don't want to interfere with a potential local instance. Therefore, none of the data and configuration files should be written at the usual locations.

A portable Kiwix is technically defined when there is (an empty) file .portable just beside the Kiwix binary. Detecting the presence of that file will activate the portable mode.

The portable mode will read/write the data files to another (predefined) location positioned relatively position to the Kiwix binary:

  • data/kiwix-desktop.session
  • data/kiwix.session
  • data/*.zim
  • ...

In such a mode nothing should be written outside the local Kiwix data directory.

This issue superseeds older issuer #630

@kelson42 kelson42 added this to the 2.4.0 milestone Aug 1, 2024
@kelson42 kelson42 modified the milestones: 2.4.0, 2.5.0 Aug 1, 2024
@sgourdas
Copy link
Collaborator

sgourdas commented Aug 5, 2024

@kelson42 for implementation purposes, if the .portable is present, can I assume that the packager will have also created the data directory as well?

@kelson42
Copy link
Collaborator Author

kelson42 commented Aug 5, 2024

@kelson42 for implementation purposes, if the .portable is present, can I assume that the packager will have also created the data directory as well?

Yes you can

@sgourdas
Copy link
Collaborator

sgourdas commented Aug 5, 2024

Since getDataDirectory() will need to be modified, so as to not complicate things with libkiwix, I will wait a bit on this until #1169 is merged.

@kelson42
Copy link
Collaborator Author

kelson42 commented Aug 16, 2024

@sgourdas Any news here? We need to be able to mov a bit in parallel as it might take again a few additional days to update the libkiwix with your PR.

@sgourdas
Copy link
Collaborator

Ok, I will start parallel work on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: DONE
Development

Successfully merging a pull request may close this issue.

2 participants