-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Julius Härtl <jus@bitgrid.net>
- Loading branch information
1 parent
85f756d
commit 3b9ec4f
Showing
7 changed files
with
139 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
name: Publish MkDocs to GitHub Pages | ||
|
||
# Simple workflow for deploying static content to GitHub Pages | ||
name: Deploy static content to Pages | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: [$default-branch] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
# Single deploy job since we're just deploying | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Setup Pages | ||
uses: actions/configure-pages@v3 | ||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.x | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install mkdocs mkdocs-material | ||
- name: Build MkDocs | ||
run: mkdocs build | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
# Upload entire repository | ||
path: './site' | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Setup hooks | ||
|
||
In order to customize the behavior of the application, you can use hooks. Hooks need to be placed in the `data/shared/hooks/` directory. They will be picked up by the docker containers automatically. They can be used for automating setup specific to a developers use cases. For example, you can use them to create a user, install an app, or run a script before or after the installation of Nextcloud. | ||
|
||
The following hooks are currently available: | ||
- before-install.sh Runs before the installation of Nextcloud | ||
- after-install.sh Runs after the installation of Nextcloud | ||
- before-start.sh Runs before the start of Nextcloud webserver | ||
- after-start.sh Runs after the start of Nextcloud webserver | ||
|
||
## Example for after-install.sh | ||
|
||
```bash | ||
#!/bin/bash | ||
|
||
echo 'Create some users' | ||
export OC_PASS=mycustomuser | ||
occ user:add --password-from-env mycustomuser | ||
``` | ||
|
||
## Example for before-start.sh | ||
|
||
```bash | ||
#!/bin/bash | ||
|
||
echo 'Always disable the firstrunwizard' | ||
occ app:disable firstrunwizard | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Nextcloud docker development environment | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Antivirus | ||
|
||
```bash | ||
docker-compose up -d proxy nextcloud av | ||
``` | ||
|
||
The [ClamAV](https://www.clamav.net/) antivirus will then be exposed as a daemon with host `nextav` and | ||
port `3310`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Nextcloud Office / Collabora Online | ||
|
||
Nextcloud Office is a self-hosted and online office suite that can be used with Nextcloud based on Collabora Online. | ||
|
||
## Automatic setup | ||
|
||
A script is available to automatically setup Collabora Online for you combined with an already running Nextcloud container. | ||
|
||
It requires to have the [richdocuments](https://github.com/nextcloud/richdocuments) app cloned into your apps directory. | ||
|
||
```bash | ||
./scripts/enable-collabora <container-name> | ||
``` | ||
|
||
## Manual steps | ||
|
||
- Make sure to have the Collabora hostname setup in your `/etc/hosts` file: `127.0.0.1 collabora.local` | ||
- Clone, build and enable the [richdocuments](https://github.com/nextcloud/richdocuments) app | ||
- Start the Collabora Online server in addition to your other containers `docker-compose up -d collabora` | ||
- Make sure you have the [richdocuments app](https://github.com/nextcloud/richdocuments) cloned to your `apps-extra` directory and built the frontend code of the app with `npm ci && npm run build` | ||
- Enable the app and configure `collabora.local` in the Collabora settings inside of Nextcloud | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# ONLYOFFICE | ||
|
||
ONLYOFFICE is a self-hosted office suite that can be used with Nextcloud. | ||
|
||
## Automatic setup | ||
|
||
A script is available to automatically setup ONLYOFFICE for you combined with an already running Nextcloud container. | ||
|
||
It requires to have the onlyoffice integration app cloned into your apps directory. | ||
|
||
```bash | ||
./scripts/enable-onlyoffice <container-name> | ||
``` | ||
|
||
## Manual steps | ||
|
||
- Make sure to have the ONLYOFFICE hostname setup in your `/etc/hosts` file: `127.0.0.1 onlyoffice.local` | ||
- Start the ONLYOFFICE server in addition to your other containers `docker-compose up -d onlyoffice` | ||
- Clone https://github.com/ONLYOFFICE/onlyoffice-nextcloud into your apps directory | ||
- Enable the app and configure `onlyoffice.local` in the ONLYOFFICE settings inside of Nextcloud |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
site_name: nextcloud-docker-dev | ||
theme: | ||
name: readthedocs |