This project is under active development and is not ready for production use.
Speedia OS is a streamlined container image equipped with a REST API, CLI, and user-friendly dashboard, purpose-built to simplify the deployment of your applications within a container environment.
To run Speedia OS as a container, you can use the image available at DockerHub with the following command:
podman run --name sos --env 'VIRTUAL_HOST=speedia.net' --rm -p 1618:1618 -it docker.io/speedianet/os:latest
Feel free to rename the container, vhost and change the host port as you wish. Speedia OS should work with Docker, Docker Swarm, Rancher, Kubernetes, Portainer or any other tool that supports OCI-compliant containers.
You can publish port 80 and 443 to the host when running Speedia OS in a virtual machine or bare metal server so that you don't need to use a reverse proxy, as long as your intention is to run a single application in that server.
In this repository you'll find the REST API and CLI code plus the dashboard assets. The API and CLI uses Clean Architecture, DDD, TDD, CQRS, Object Calisthenics, etc. Understand how these concepts works before proceeding is advised.
To run this project during development you must install Air. Air is a tool that will watch for changes in the project and recompile it automatically.
You must have an .env file in the root of the git directory during development. You can use the .env.example file as a template. Air will read the .env file and use it to run the project during development.
If you add a new env var that is required to run the apis, please add it to the src/presentation/shared/checkEnvs.go file.
When running in production, the /speedia/.env file is only used if the environment variables weren't set in the system. For instance, if you want to set the ENV1 variable, you can do it in the .env file or in the command line:
ENV1=XXX /speedia/sos
Speedia OS commands can harm your system, so it's important to run the unit tests in a proper container:
podman build -t sos-unit-test:latest -f Containerfile.test .
podman run --rm -it sos-unit-test:latest
Make sure you have the .env file in the root of the git directory before running the tests.
The src/devUtils folder is not a Clean Architecture layer, it's there to help you during development. You can add any file you want there, but it's not recommended to add any file that is not related to development since the code there is meant to be ignored by the build process.
For instance there you'll find a testHelpers.go file that is used to read the .env during tests.
To build the project, run the command below. It takes two minutes to build the project at first. After that, it takes less than 10 seconds to build.
podman build -t sos:latest .
To run the project you may use the following command:
podman run --name sos --env 'VIRTUAL_HOST=speedia.net' --rm -p 1618:1618 -it sos:latest
When testing, consider publishing port 80 and 443 to the host so that you don't need to use a reverse proxy.
The following extensions are highly encouraged to be used during development:
EditorConfig.EditorConfig
GitHub.copilot
GitHub.vscode-pull-request-github
esbenp.prettier-vscode
foxundermoon.shell-format
golang.go
hbenl.vscode-test-explorer
ms-vscode.test-adapter-converter
redhat.vscode-yaml
streetsidesoftware.code-spell-checker
streetsidesoftware.code-spell-checker-portuguese-brazilian
timonwong.shellcheck
The API accepts two types of tokens and uses the standard "Authorization: Bearer <token>" header:
-
sessionToken: is a JWT, used for dashboard access and generated with the account login credentials. The token contains the accountId, IP address and expiration date. It expires in 3 hours and only the IP address used on the token generation is allowed to use it.
-
accountApiKey: is a token meant for M2M communication. The token is a AES-256-CTR-Encrypted-Base64-Encoded string, but only the SHA3-256 hash of the key is stored in the server. The accountId is retrieved during key decoding, thus you don't need to provide it. The token never expires, but the user can update it at any time.
To generate the swagger documentation, you must use the following command:
swag init -g src/presentation/api/api.go -o src/presentation/api/docs
The annotations are in the controller files. The reference file can be found here.