diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ec54736 --- /dev/null +++ b/.gitignore @@ -0,0 +1,188 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..7a412bc --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "tcposcrouter"] + path = tcposcrouter + url = https://github.com/bgola/tcposcrouter.git diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e90533 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# HyperDisCo + +HyperDisCo implements an Etherpad-like syncing for SuperCollider documents. + +## Setup + +Start by installing the Quark via + +```supercollider +// install quark +Quarks.install("https://github.com/aiberlin/HyperDisCo.git"); + +// recompile interpreter +thisProcess.recompile; +``` + +## Available servers + +Host | Port | Comment +--- | --- | --- +`bgo.la` | `55555` | Default server - provided by developer +`hyperdisco.dennis-scheiba.com` | `55555` | Provided by developer + +## Server setup + +If you want to run a server on your own you can use docker for this. +This also allows you to use HyperDisCo in your local area network (LAN) without internet. + +Start by cloning the repository to your local folder + +```shell +git clone --recurse-submodules https://github.com/aiberlin/HyperDisCo.git && \ +cd HyperDisCo +``` + +and spin up the server with + +```shell +docker-compose up -d +``` + +where the `-d` flag indicates that the docker container should start as daemon. + +Have in mind that the port mapping of the `docker-compose.yml` maps port `55555` to `55550` and `55556` to `55551`. +This is because on macOS the port `55555` is already taken by the operating system and can not be used. +Also, when running on a server, this allows to run the service behind a reverse proxy such as nginx. + +If executed on your local machine you should therefore connect to `localhost:55550`. + +To stop the server execute + +```shell +docker-compose down +``` + +in the directory of the `docker-compose.yml` file. + +## License + +GPL diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..170c6b9 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,14 @@ +version: '3.9' + +services: + tcposcrouter: + build: tcposcrouter + ports: + - "55550:55555/tcp" + - "55551:55556/tcp" + deploy: + restart_policy: + condition: on-failure + delay: 5s + max_attempts: 3 + window: 120s diff --git a/tcposcrouter b/tcposcrouter new file mode 160000 index 0000000..12b4942 --- /dev/null +++ b/tcposcrouter @@ -0,0 +1 @@ +Subproject commit 12b49422ffd9383b04f811bd6c4e5b70d61cfe1d