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

Readme.md incorrect refers to ‘settings.json’ #442

Closed
MrACP1911 opened this issue Aug 21, 2021 · 15 comments
Closed

Readme.md incorrect refers to ‘settings.json’ #442

MrACP1911 opened this issue Aug 21, 2021 · 15 comments

Comments

@MrACP1911
Copy link

File does not exist

@EricClaeys
Copy link
Collaborator

Thomas, I asked MrACP1911 to submit this after reading his Facebook post about it.
The README.md file refers to "settings.json" but the actual name of the file is "settings_RPiHQ.json" or "settings_ZWO.json". I will fix and commit to the dev branch.

@MrACP1911
Copy link
Author

MrACP1911 commented Aug 23, 2021 via email

EricClaeys added a commit that referenced this issue Aug 23, 2021
Fixes #442 
and adds some additional clarifications.
@EricClaeys
Copy link
Collaborator

No, you did exactly what I asked. Thanks you.
I was just giving Thomas some background.

@thomasjacquin
Copy link
Collaborator

Thanks Eric, I'll take a look.

@MrACP1911
Copy link
Author

MrACP1911 commented Aug 23, 2021 via email

@EricClaeys
Copy link
Collaborator

You can send Thomas money using the link at the very bottom the page with README.md on it.

@swatty007
Copy link

Good, I see this post now that explains my confusion at least a bit 😁

Looks like I hit a good timing to do my initial deployment then as I stumbled a bit across this one 🤣

The documentation referred to a file I couldn’t find. I did notice the settings_RPiHQ.json within the project's root folder and tried adjusting it without any effect. Then I found one under “/etc/raspap/settings_RPiHQ.json” which does affect my camera settings, e.g. time display, etc., and then there's also the GUI which displays a camera config.

This is the point I got lost. What is now the correct path/file to adjust things?
There's maybe some documentation that explains what I missed. What the correct/intended way of adjusting things is?

What I understand is there are camera-dependent configs for the ZWO/RPiHQ camera.
And I assume the "*RPiHQ/ZWO.json.repo" files within the project are essentially the source/template file that gets published during deployment? But why within different locations :/

Would appreciate it if someone could light me up on this one :)

@EricClaeys
Copy link
Collaborator

swatty07,
I was also very confused about this. It is mentioned in the documentation but is still confusing.
When you install "allsky" the first time, those configuration files are in ~/allsky. If you then install the admin GUI ("allsky-portal"), those files are copied to /etc/raspap and they are used instead.
I will ask Thomas why they are not removed from ~/allsky, or at least renamed. I will also ask why they are moved at all, since config.sh isn't moved.
In summary, since you have the GUI installed, use the file in /etc/raspap.

You are correct that the .repo files are the templates with default settings. They are never updated.
Eric

@EricClaeys
Copy link
Collaborator

... never updated unless we change the defaults.

@thomasjacquin
Copy link
Collaborator

Hi Martin,

I'm glad you asked. By default, the location of the settings file is at the root of the project. (/home/pi/allsky).
However, if you install and use the GUI, the Camera Settings page is located at /var/www/html/includes/camera_settings.php
I couldn't figure out how to give the web server (lighttpd) write access to /home/pi/allsky from /var/www/html. I'm sure this is some kind of permission or lighttpd configuration.
To solve this, I decided to copy the settings file to /etc/raspap/ where I have write access.
Ideally, there should be only 1 location for the settings file, I agree.

In summary,

  • if you're not using the GUI, modify settings in /home/pi/allsky.
  • if you're using the GUI, modify settings in /etc/raspap. But the GUI should take care of this so you don't have to manually edit it.

Thomas

@EricClaeys
Copy link
Collaborator

Thomas,
To avoid confusion, simplify things, and make them slightly more uniform, could the installation of "allsky" put the files, plus the config.sh file, in /etc/raspap? There would then only be one location. Moving config.sh would require updating lots of scripts, but the change should be trivial.

I find the admin GUI to be very useful and easier to explain to people who ask about settings. Have you ever considered merging it with "allsky"?
Eric

@swatty007
Copy link

Ah yeah, I see makes sense. Thanks for the quick reply both 😁

Just now I found the note about this within the config.sh properties table (last line of the config.sh table). Maybe it's an idea to separate this note from the table and put it into a pull quote below to avoid people overlook this?
I probably scrolled over this a “few” times 😖 If you like I can commit a pull request for it.

Yeah, haven’t touched lighttpd either for quite a while, more used to its bigger brothers. But I would imagine you could get it done via a symlink. Maybe:
sudo ln -s /home/pi/allsky/config.sh /var/www/html/config.sh
during the installation would do the job (haven’t it tested yet though).

This brings me to another thing I just noticed, but I will make a separate ticket for it.

@swatty007
Copy link

I find the admin GUI to be very useful and easier to explain to people

Actually, it could already help to add the path within the GUI as well. e.g. just display the absolute path below the editor & camera config.

Should be a trivial adjustment as well and which makes it more obvious for people what files to look for and more dynamic than a documentation you have to keep in sync.

@EricClaeys
Copy link
Collaborator

Martin,
One of the advantages of the GUI is that people don't need to know where the file is, or even that there IS a file. It hides that complexity.

@EricClaeys
Copy link
Collaborator

Martin,
Now that I have both a ZWO and RPiHQ camera I wanted a way to easily distinguish them in the GUI, so I added the pathname to the camera options file. I'm still not sure I like the idea of putting the file name there, rather than just "ZWO Camera" or "RPiHQ Camera" (maybe with the path as a rollover).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants