horahoradev
diff --git a/‎.dockerignore‎
Lines changed: 1 addition & 0 deletions b/‎.dockerignore‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎.github/workflows/test.yml‎
Lines changed: 29 additions & 35 deletions b/‎.github/workflows/test.yml‎
Lines changed: 29 additions & 35 deletions
diff --git a/‎.gitignore‎
Lines changed: 16 additions & 2 deletions b/‎.gitignore‎
Lines changed: 16 additions & 2 deletions
diff --git a/‎.vscode/extensions.json‎
Lines changed: 6 additions & 0 deletions b/‎.vscode/extensions.json‎
Lines changed: 6 additions & 0 deletions
diff --git a/‎.vscode/horahora.code-workspace.example‎
Lines changed: 95 additions & 0 deletions b/‎.vscode/horahora.code-workspace.example‎
Lines changed: 95 additions & 0 deletions
diff --git a/‎.vscode/settings.json‎
Lines changed: 20 additions & 0 deletions b/‎.vscode/settings.json‎
Lines changed: 20 additions & 0 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 4 additions & 4 deletions b/‎CONTRIBUTING.md‎
Lines changed: 4 additions & 4 deletions
diff --git a/‎Dockerfile‎
Lines changed: 8 additions & 2 deletions b/‎Dockerfile‎
Lines changed: 8 additions & 2 deletions
diff --git a/‎Dockerfile.postgres.dev‎
Lines changed: 1 addition & 0 deletions b/‎Dockerfile.postgres.dev‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎README.md‎
Lines changed: 69 additions & 8 deletions b/‎README.md‎
Lines changed: 69 additions & 8 deletions
@@ -0,0 +1 @@
+videos/*
@@ -10,17 +10,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Log in to the Container registry
-        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
       - name: Build the stack
         run: ./up.sh
       - name: Run integration tests
@@ -35,36 +24,41 @@ jobs:
       - name: print relevant logs (scheduler)
         run: docker logs $(docker ps | grep "scheduler" | awk '{print $1}')
         if: always()
-      - name: print relevant logs (redis)
-        run: docker logs $(docker ps | grep "redis" | awk '{print $1}')
-        if: always()
       - name: print relevant logs (postgres)
         run: docker logs $(docker ps | grep "postgres" | awk '{print $1}')
         if: always()
       - name: print relevant logs (frontapi)
         run: docker logs $(docker ps | grep "frontapi" | awk '{print $1}')
         if: always()
-      - name: Build and push Docker image for userservice
-        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
         with:
-          context: user_service
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}_userservice
-          labels: ${{ steps.meta.outputs.labels }}_userservice
-        if: github.ref == 'refs/heads/master'
-      - name: Build and push Docker image for videoservice
-        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
         with:
-          context: video_service
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}_videoservice
-          labels: ${{ steps.meta.outputs.labels }}_videoservice
-        if: github.ref == 'refs/heads/master'
-      - name: Build and push Docker image for scheduler
-        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: copy
+        run: cp ./configs/.env.dev.example .env
+      - name: copy
+        run: cp ./configs/.env.dev.example .env.dev
+      - name: publish
+        uses: pennsignals/publish_docker-compose@v0.2.5
+        with:
+          version: dev
+          docker_compose: 'compose.dev.yaml' # required
+      - name: copy env
+        run: cp ./configs/.env.example .env
+        if: always()
+      - name: publish
+        uses: pennsignals/publish_docker-compose@v0.2.5
         with:
-          context: scheduler
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}_scheduler
-          labels: ${{ steps.meta.outputs.labels }}_scheduler
-        if: github.ref == 'refs/heads/master'
+          version: main
+          docker_compose: 'docker-compose.yml' # required
@@ -1,7 +1,21 @@
+# CLI build output
+/horahora
+# CLI windows build output
+/horahora.exe
+
+# vscode files
+*.code-workspace
+
+# temporary folders created by golang watcher
+**/tmp/*
+
 youtube-dl*
 packer/vpn_conf*
 data*
 secrets.env
-docker-compose.yml
 sql/backup*
-/videos
+/videos
+
+# env file is used for the docker compose
+/.env
+/.env*
@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    // https://go.dev/doc/editors#options
+    "golang.go",
+  ]
+}
@@ -0,0 +1,95 @@
+{
+	"folders": [
+		{
+			"name": "horahora",
+			"path": "."
+		},
+		{
+			"name": "front_api",
+			"path": "front_api"
+		},
+		{
+			"name": "backup_service",
+			"path": "backup_service"
+		},
+		{
+			"name": "scheduler",
+			"path": "scheduler"
+		},
+		{
+			"name": "stomp_proxy",
+			"path": "stomp_proxy"
+		},
+		{
+			"name": "tests",
+			"path": "tests"
+		},
+		{
+			"name": "user_service",
+			"path": "user_service"
+		},
+		{
+			"name": "video_service",
+			"path": "video_service"
+		},
+		{
+			"name": "webapp",
+			"path": "webapp"
+		},
+		{
+      "name": "cli",
+      "path": "cli"
+    },
+		{
+			"name": "schema",
+			"path": "schema"
+		}
+	],
+	"settings": {
+		"files.exclude": {
+			"**/.git": true,
+			"**/.svn": true,
+			"**/.hg": true,
+			"**/CVS": true,
+			"**/.DS_Store": true,
+			"**/Thumbs.db": true,
+			"**/node_modules": true,
+			"front_api": true,
+			"backup_service": true,
+			"scheduler": true,
+			"stomp_proxy": true,
+			"tests": true,
+			"user_service": true,
+			"video_service": true,
+			"webapp": true,
+			"schema": true,
+			"cli": true
+		},
+		"files.associations": {
+			// syntax highlight for example env files
+			"**/.env*": "dotenv",
+			// syntax highlight for example workspace files
+			"**/*.code-workspace*": "jsonc"
+		},
+		// remove text 3 options if you've set them up in global editor settings
+		"files.trimTrailingWhitespace": true,
+  	"files.insertFinalNewline": true,
+  	"files.trimFinalNewlines": true
+	},
+	"extensions": {
+		"recommendations": [
+			// `.env` syntax highlight
+			"mikestead.dotenv",
+			// docker-related features plus highlight in dockerfiles and compose configs
+			"ms-azuretools.vscode-docker",
+			// lots of QoL git features
+			"eamodio.gitlens",
+			// nginx config highlight
+			"ahmadalli.vscode-nginx-conf",
+			// `.sql` formatter
+			"bradymholt.pgformatter",
+			// `.proto3` syntax highlight
+			"zxh404.vscode-proto3"
+		]
+	}
+}
@@ -0,0 +1,20 @@
+{
+  "gopls": {
+    "ui.semanticTokens": true
+  },
+  "[json]": {
+    "editor.tabSize": 2
+  },
+  "[jsonc]": {
+    "editor.tabSize": 2
+  },
+  "json.schemas": [
+    {
+      "fileMatch": ["schema/**/*schema.json"],
+      "url": "./schema/meta.schema.json"
+    }
+  ],
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true
+}
@@ -5,10 +5,10 @@ Thank you for your interest in contributing to Horahora! Think you can do better
 ![](https://raw.githubusercontent.com/horahoradev/horahora/master/Architectural_Drawing.png)
 
 Horahora's architecture is microservice-based. The main microservices are:
-- front_api: which is the RESTful API to the rest of the services
-- userservice: which does all authentication and handles user storage/permissions
-- videoservice: which does all video storage, uploads to the origin (e.g. s3/backblaze), queries, transcoding, etc
-- scheduler: which handles content archival requests and downloads
+- `front_api`: which is the RESTful API to the rest of the services
+- `userservice`: which does all authentication and handles user storage/permissions
+- `videoservice`: which does all video storage, uploads to the origin (e.g. s3/backblaze), queries, transcoding, etc
+- `scheduler`: which handles content archival requests and downloads
 Communication between userservice, videosercvice, and scheduler is GRPC-based. For more details on individual microservice architecture, see the README for whichever microservice.
 
 Postgresql is used as the database for each service, but Redis is also used for very specific purposes (e.g. distributed locking). Schema migrations can be found within the "migrations" directory within each service. As an example, [here's the migrations directory for Videoservice](https://github.com/horahoradev/horahora/tree/master/video_service/migrations). Migrations are applied using Flyway as a means of providing schema versioning.
 
@@ -1,12 +1,18 @@
-FROM golang
+FROM golang:1.17
 
 RUN apt-get update && \
     apt install -y protobuf-compiler && \
     go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26 && \
     go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1
 
+RUN go env -w GO111MODULE="off" && \
+    go get github.com/envoyproxy/protoc-gen-validate && \
+    go env -w GO111MODULE=""
+
+RUN go install github.com/envoyproxy/protoc-gen-validate@v0.6.7
+
 COPY gen_all.sh /bin/gen_all.sh
 
 WORKDIR /
 
-ENTRYPOINT ["/bin/gen_all.sh"]
+ENTRYPOINT ["/bin/gen_all.sh"]
@@ -0,0 +1 @@
+postgres/Dockerfile.dev
@@ -11,26 +11,87 @@ It allows you to:
 
 Join our Discord: https://discord.gg/vfwfpctJRZ
 
-![](https://raw.githubusercontent.com/horahoradev/horahora-designs/master/video_page_dark.png)
+![](https://github.com/horahoradev/horahora-designs/blob/master/Screenshot%20from%202022-10-09%2011-56-34.png?raw=true)
 
-![](https://raw.githubusercontent.com/horahoradev/horahora-designs/master/homepage_dark.png)
+![](https://github.com/horahoradev/horahora-designs/blob/master/Screenshot%20from%202022-10-09%2011-54-48.png?raw=true)
 
-![](https://raw.githubusercontent.com/horahoradev/horahora-designs/master/archival_page_dark.png)
+![](https://github.com/horahoradev/horahora-designs/blob/master/Screenshot%20from%202022-10-09%2011-57-35.png?raw=true)
+
+![](https://github.com/horahoradev/horahora-designs/blob/master/Screenshot%20from%202022-10-09%2011-57-52.png?raw=true)
 
 Archival capabilities are provided by yt-dlp (a fork of youtube-dl).
 
 ## Local Use Instructions (START HERE)
 
 1. Install docker and docker-compose
-2. Run: sudo ./up.sh
-3. Wait a minute, then visit localhost:80
-4. Login as admin/admin
+2. Generate private key:
+   ```sh
+   openssl genrsa 2048
+   ```
+3. Create env vars file:
+   ```sh
+   cp configs/.env.example .env
+   ```
+4. Save the private key into `JWT_KEYPAIR` value:
+   ```sh
+   JWT_KEYPAIR="-----BEGIN RSA PRIVATE KEY-----
+   ...
+   -----END RSA PRIVATE KEY-----"
+   ```
+   The value should be double-quoted.
+5. Start up the stack:
+    ```sh
+    sudo ./up.sh
+    ```
+6. Wait a minute, then visit localhost:80
+7. Login as admin/admin
     - note that with the current video approval workflow, non-admin users won't be able to view unapproved videos
     - it's recommended to visit /password-reset immediately to change the admin user's default password if using in an untrusted environment
-5. navigate to the archival requests page from the hamburger menu, add a link, and wait a few minutes
-  
+8. navigate to the archival requests page from the hamburger menu, add a link, and wait a few minutes
+
 That's it for basic usage, and should work. If that doesn't work, bug me on Discord.
 
+## Develop
+**DO NOT RUN THIS SETUP IN ANY PUBLIC CONTEXT.**
+
+### Requirements
+
+Golang - 1.18+
+
+### Docker stack
+1. Copy example env file:
+   ```sh
+   cp ./configs/.env.dev.example .env.dev
+   ```
+
+2. Build the local images:
+   ```sh
+   docker-compose --env-file .env.dev build
+   ```
+
+3. Start the dev stack:
+   ```sh
+   docker-compose --env-file .env.dev up --build
+   ```
+
+4. Tear down the dev stack:
+   ```sh
+   docker-compose --env-file .env.dev down
+   ```
+
+### CLI (experimental)
+
+1. Build CLI tool in the project root:
+   ```sh
+   cd cli && go build -o ../horahora . && cd ..
+   ```
+
+2. Use CLI tool:
+   ```sh
+   ./horahora
+   ```
+   Instructions and available commands will be shown within it.
+
 ## Contributing
 Contributions are always welcome. Please see [CONTRIBUTING.md](https://github.com/horahoradev/horahora/blob/master/CONTRIBUTING.md) for details, including an architectural rundown.