From 1055c7846bb8ae79f19d09bfad5f40b86d3a9d45 Mon Sep 17 00:00:00 2001 From: Dziad Borowy Date: Wed, 27 Apr 2022 09:54:48 +0100 Subject: [PATCH 1/3] notea --- README.md | 1 + apps/wiki/notea.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 apps/wiki/notea.md diff --git a/README.md b/README.md index 902c46d..292e0b9 100644 --- a/README.md +++ b/README.md @@ -348,6 +348,7 @@ The aims is to provide a ready-to-run recipes that you can just copy, paste and - [Confluence](apps/wiki/confluence.md) - [Bluespice free](apps/wiki/bluespice.md) - [Bookstack](apps/wiki/bookstack.md) +- [Notea](apps/wiki/notea.md) - [Wiki.js](apps/wiki/wikijs.md) - [XWiki](apps/wiki/xwiki.md) diff --git a/apps/wiki/notea.md b/apps/wiki/notea.md new file mode 100644 index 0000000..f9982c2 --- /dev/null +++ b/apps/wiki/notea.md @@ -0,0 +1,63 @@ +# Notea + +- This is probably more of a note-taking app rather than a wiki, but why not :-) +- Setup with docker is a bit more challenging than the usual `docker-compose up -d` +- Layout is very minimalistic +- Command palette! +- `/` when writing is great! +- Extremely fast to start-up (not really a feature, but still impressive) + +
+ +- [Homepage](https://cinwell.com/notea/) +- [GitHub repo](https://github.com/QingWei-Li/notea) + + +## docker-compose.yml +```yml +--- +services: + notea: + image: cinwell/notea + container_name: notea + environment: + - STORE_ACCESS_KEY=086o0ITYnydXRzxO + - STORE_SECRET_KEY=7FKZabUq7LCWyhgYyTh39A26vZMKb99G + - STORE_BUCKET=notea + - STORE_END_POINT=http://notea-db:9000 + - STORE_FORCE_PATH_STYLE=true + - COOKIE_SECURE=false + - BASE_URL="http://192.168.1.10:3123/" + #- PASSWORD=notea + - DISABLE_PASSWORD=true + ports: + - "3123:3000" + + notea-db: + image: minio/minio + container_name: notea-db + command: server /data --console-address ":9001" + environment: + #- MINIO_BROWSER=off + - MINIO_ROOT_USER=admin + - MINIO_ROOT_PASSWORD=admin123 + ports: + - "3124:9000" + - "3125:9001" + volumes: + - ./data:/data +``` + +### Next steps +Notea requires external storage. Minio container stands in place of Amazon S3. We just need to create a "Bucket" in minio, so: +#### Create a Bucket +1. Go to (- minio admin console) +2. Login using `admin:admin123` credentials from `docker-compose.yml` file +3. Create a new bucket with the name `notea` (no need for any other options, just name) + +#### Access Keys +1. Next click "Identity/Service Accounts" in the sidebar and click "Create service account" button +2. Either copy the "Access Key" and "Secret Key" from the yaml above or generate a new pair of keys and update them in your `docker-compose.yml` (and restart it afterwards). + +That's it! +Notea should be available at From 0439636c54443490151bc6c516e5a648742d723f Mon Sep 17 00:00:00 2001 From: Dziad Borowy <392513+tborychowski@users.noreply.github.com> Date: Wed, 27 Apr 2022 09:55:58 +0100 Subject: [PATCH 2/3] Update notea.md --- apps/wiki/notea.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/apps/wiki/notea.md b/apps/wiki/notea.md index f9982c2..e434a85 100644 --- a/apps/wiki/notea.md +++ b/apps/wiki/notea.md @@ -51,7 +51,7 @@ services: ### Next steps Notea requires external storage. Minio container stands in place of Amazon S3. We just need to create a "Bucket" in minio, so: #### Create a Bucket -1. Go to (- minio admin console) +1. Go to `` (- minio admin console) 2. Login using `admin:admin123` credentials from `docker-compose.yml` file 3. Create a new bucket with the name `notea` (no need for any other options, just name) @@ -60,4 +60,5 @@ Notea requires external storage. Minio container stands in place of Amazon S3. W 2. Either copy the "Access Key" and "Secret Key" from the yaml above or generate a new pair of keys and update them in your `docker-compose.yml` (and restart it afterwards). That's it! -Notea should be available at + +Notea should be available at `` From a2a8f2cb25d076d7c045518edd08bea8111daa3b Mon Sep 17 00:00:00 2001 From: Dziad Borowy Date: Fri, 6 May 2022 23:10:49 +0100 Subject: [PATCH 3/3] update docker installation docs --- docker/get-started.md | 36 +++++++++++++----------------------- 1 file changed, 13 insertions(+), 23 deletions(-) diff --git a/docker/get-started.md b/docker/get-started.md index 0061e4c..9e20a61 100644 --- a/docker/get-started.md +++ b/docker/get-started.md @@ -8,35 +8,25 @@ Installation instructions for Ubuntu Linux from: https://docs.docker.com/engine/ sudo apt-get remove docker docker-engine docker.io containerd runc ``` -## Install Docker +## Install Docker & docker-compose-plugin (on Ubuntu) ```sh -sudo apt-get update -sudo apt-get install apt-transport-https ca-certificates curl gnupg-agent software-properties-common -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - -sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" -sudo apt-get update -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` +sudo apt update +sudo apt install ca-certificates curl gnupg lsb-release +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg +echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - -## Install `docker-compose` -From: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04 - -```sh -sudo apt-get remove docker-compose -sudo curl -L "https://github.com/docker/compose/releases/download/1.29.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose -sudo chmod +x /usr/local/bin/docker-compose -sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose +sudo apt update +sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin ``` ## Usage Full docs are here: https://docs.docker.com/compose/reference/overview/ -Generally the idea of `docker-compose` command is simple: +Generally the idea of `docker compose` command is simple: 1. First you create a folder for your service, e.g. `home-assistant` 2. Then you then create a `docker-compose.yml` file, which describes the service containers -3. You run `docker-compose up -d` and you're done! +3. You run `docker compose up -d` and you're done! Here are the most frequently used commands: @@ -44,20 +34,20 @@ Here are the most frequently used commands: #### Start a container `-d` starts in a detached mode - which basically mean that it runs it in the background (so you can do other stuff, instead of looking at the logs). ```sh -docker-compose up -d +docker compose up -d ``` ### Stop a container There are 2 options: ```sh -docker-compose stop -docker-compose down +docker compose stop +docker compose down ``` First one (`stop`) onlu stops the containers, whereas the latter (`down`) does some more cleaning (removes the containers, networks, volumes), so I generally recommend `down` if you're tinkering. ### Update a container to use the latest published image ```sh -docker-compose pull && docker-compose up -d +docker compose pull && docker compose up -d ``` This pulls the latest images as defined in the local `docker-compose.yml` and recreates the containers.