-
Notifications
You must be signed in to change notification settings - Fork 24
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
Easier docker-based server installation #4446
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. See my remark about version pinning.
Tested and works.
docs/installation.md
Outdated
# e.g. https://webknossos.example.com | ||
# Set up your organization and admin account using the onboarding screens (see below) | ||
|
||
# Start webKnossos in the background |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Start webKnossos in the background | |
# Alternatively, start webKnossos in the background |
|
||
# Start webKnossos and supply the PUBLIC_HOST and LETSENCRYPT_EMAIL variables | ||
# In addition to webKnossos, we also start an nginx proxy with automatic | ||
# SSL certificate management via letsencrypt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# SSL certificate management via letsencrypt | |
# SSL certificate management via letsencrypt | |
# Note: Do not include 'HTTP' or 'HTTPS' in the PUBLIC_HOST URI |
docs/installation.md
Outdated
For larger datasets, we recommend the file system upload. | ||
Read more about the import functionality in the [Datasets guide](./datasets.md). | ||
|
||
If you do not have a compatible dataset available, you can use one of the [sample datasets](./datasets.md#sample-datasets) for testing purposes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Evtl. noch ein Verweis zum Cuber? (e.g. die Tools Seite in Docs)
Co-Authored-By: Tom Herold <[email protected]>
Looks good. |
This PR makes the installation on a custom server much easier. Users only have to download 1 docker-compose file and follow a few steps in order to get an HTTPS-secured public installation of webKnossos.
Regular backups and monitoring is not included and available via paid service plans.
Steps to test:
Issues:
- [ ] Updated migration guide if applicable- [ ] Adapted wk-connect if datastore API changes- [ ] Needs datastore update after deployment