Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akdasa-studios/shlokas-server
https://github.com/akdasa-studios/shlokas-server
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/akdasa-studios/shlokas-server
- Owner: akdasa-studios
- Created: 2023-02-04T14:28:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T17:56:05.000Z (about 1 year ago)
- Last Synced: 2024-05-01T09:40:05.288Z (8 months ago)
- Language: Shell
- Size: 43.9 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This repository organizes several docker containers to run the application:
1. [Database](https://github.com/akdasa-studios/shlokas-db) – database for storing user data
2. [Authentication](https://github.com/akdasa-studios/shlokas-auth) – authentication server for user login
3. [Landing](https://github.com/akdasa-studios/shlokas-landing) – landing page for the application
4. [Balancer](https://github.com/akdasa-studios/shlokas-balancer) – load balancer for the application
5. [Balancer](https://github.com/akdasa-studios/shlokas-content) – content server for the application
6. [Admin](https://github.com/akdasa-studios/shlokas-admin) – admin server for the application
## Development
Clone all the repositories related to the application. The following commands will clone all the repositories in the current directory:
```sh
gh search repos --owner akdasa-studios --match name shlokas --visibility public | while read -r repo _; do
gh repo clone "$repo" "$repo"
done
```
#### GitHub Personal Access Token
The GitHub Personal Access Token is required to pull the images from the GitHub Container Registry. You can create a token [here](https://github.com/settings/tokens). The token should have the `packages:read` permission. After creating the token, you can set it as an environment variable. The following commands will build all the images and run the application:
```sh
export GITHUB_TOKEN=your_token
cd ./akdasa-studios/shlokas-server
./shlokas.build.sh dev
./shlokas.run.sh dev
```
‼️ Note: Without token you won't be able to build the images and you will get the following error:
```
#0 39.47 npm ERR! code E401
#0 39.47 npm ERR! 401 Unauthorized - GET https://npm.pkg.github.com/[OMITED] - unauthenticated: User cannot be authenticated with the token provided.
```
## Production
In production, all the images are pulled from the GitHub Container Registry. You can run the application using the following commands.
```sh
gh repo clone akdasa-studios/shlokas-server
cd ./shlokas-server
./shlokas.run.sh prod
```
### Watchtower
[Watchtower](https://containrrr.dev/watchtower/) is a tool that automatically updates running docker containers. It is configured to run on the host machine and update the containers on the docker network. It requires an authentication token to access the docker registry. The token is stored in the `config.json` file in the root directory of the project.
```json5
// config.json
{
"auths": {
"ghcr.io": {
// echo -n 'github_username:github_personal_token' | base64
"auth": "AUTH_STRING",
}
}
}
```
## Environment Variables
The following environment variables are used by the server. They are stored in the `environment.env` file in the root directory of the project. You can override these values by creating an `environment.local.env` file.
```bash
# Server settings: dev or prod
ENV=dev
# Database settings
COUCHDB_USER=dev
COUCHDB_PASSWORD=dev
COUCHDB_HOST=db
SHLOKAS_USERS_DB=users_shlokas
# Email settings for sending emails
[email protected]
SHLOKAS_EMAIL_PASSWORD=password
BALANCER_ENV=dev
```
## Updating
All the containers are updated automatically by the watchtower. But if a new container was added, you need to update the `docker-compose.yml` and cut the release. This will automatically update the repository on the server and the server will be restarted.