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

Easier docker-based server installation #4446

Merged
merged 11 commits into from
Feb 18, 2020
Merged

Conversation

normanrz
Copy link
Member

@normanrz normanrz commented Feb 17, 2020

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:


@normanrz normanrz requested a review from hotzenklotz February 17, 2020 15:58
@normanrz normanrz self-assigned this Feb 17, 2020
Copy link
Member

@hotzenklotz hotzenklotz left a 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/index.md Outdated Show resolved Hide resolved
# e.g. https://webknossos.example.com
# Set up your organization and admin account using the onboarding screens (see below)

# Start webKnossos in the background
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# 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
Copy link
Member

@hotzenklotz hotzenklotz Feb 17, 2020

Choose a reason for hiding this comment

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

Suggested change
# SSL certificate management via letsencrypt
# SSL certificate management via letsencrypt
# Note: Do not include 'HTTP' or 'HTTPS' in the PUBLIC_HOST URI

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.
Copy link
Member

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)

tools/hosting/docker-compose.yml Outdated Show resolved Hide resolved
tools/hosting/docker-compose.yml Outdated Show resolved Hide resolved
@hotzenklotz
Copy link
Member

Looks good. :shipit:

@bulldozer-boy bulldozer-boy bot merged commit ad967c0 into master Feb 18, 2020
@bulldozer-boy bulldozer-boy bot deleted the docs-hosting-docker branch February 18, 2020 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reverse Proxy Setup
2 participants