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

add file previewers to dev env, more docs #11181

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Jan 23, 2025

What this PR does / why we need it:

Developers like previewers too! Plus, we're adding some docs.

Which issue(s) this PR closes:

Special notes for your reviewer:

The previewers run on port 9080 in the development environment. In the demo/eval environment, they run on 9000 because MinIO isn't running (also on port 9000).

Suggestions on how to test this:

Try both the dev env and the "demo or eval" env.

Both should have all the previewers available.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Sort of? You can see previewers, like this:

Screenshot 2025-01-23 at 11 19 47 AM

Is there a release notes update needed for this change?:

Yes, included.

Additional documentation:

https://dataverse-guide--11181.org.readthedocs.build/en/11181/container/running/demo.html#file-previewers

@pdurbin pdurbin added Component: Containers Anything related to cloudy Dataverse, shipped in containers. Size: 3 A percentage of a sprint. 2.1 hours. FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) labels Jan 23, 2025
@@ -97,7 +97,8 @@ services:
- DATAVERSE_URL=http://dataverse:8080
- TIMEOUT=10m
- PREVIEWERS_PROVIDER_URL=http://${MACHINE_IP:-localhost}:9000
Copy link
Member Author

Choose a reason for hiding this comment

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

Should we consider removing this MACHINE_IP stuff from this compose file? We already removed it from the dev version.

Copy link
Contributor

Choose a reason for hiding this comment

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

I expect that it would make a lot of sense to be able to provide an alternative IP address (or host name) in a production environment. Leaving it in would be a good idea IMHO.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I suspect we'll dig into this more when we work on fronting Dataverse with some sort of proxy:

@cmbz cmbz added the FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) label Jan 30, 2025
@pdurbin pdurbin self-assigned this Jan 30, 2025
@pdurbin pdurbin removed their assignment Jan 30, 2025
Copy link
Contributor

@Kris-LIBIS Kris-LIBIS left a comment

Choose a reason for hiding this comment

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

I would recommend to add the --rm option to the docker run command to clean up the container after running. But besides that, this is a perfect addition.

@pdurbin
Copy link
Member Author

pdurbin commented Jan 30, 2025

@Kris-LIBIS great idea. I added the rm in 322b3a6.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Containers Anything related to cloudy Dataverse, shipped in containers. FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) Size: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: Ready for Review ⏩
Development

Successfully merging this pull request may close these issues.

enable previewers in containers
3 participants