OpenMood

Openmood is a self-hosted, modular mood tracker.

Most mood trackers seem to allow a simple numeric score between one and however many smileys they display and/or just a plaintext field. Now, for some people this may be enough, but if that isn't enough for you, that's what openmood is for.

• It's FOSS (yay, woo 🎉)
• It allows you to customize the data you wish to track.
  • Simple Text fields
  • Text selections
  • Numeric input
• You have full control over your data, because you own the server it runs on.
• Don't like the frontends we provide? Feel free to suggest improvements or even make your own.

Table of Contents

• Install from crates.io
  • Requirements
  • Installation
• Install from source
  • Requirements
  • Building the server
• Development
  • Requirements
  • Development Environment
  • Required Environment Variables
• Configuration
• License
  • Contribution

Install from crates.io

Requirements

• Rust toolchain
• You must have a postgres database running (PostgreSQL 16.0+)

Installation

1. run cargo install openmood
2. the server binary will now be available as openmood
3. run the server and configure it

Install from source

Requirements

• Rust toolchain
• You must have a postgres database running (PostgreSQL 16.0+)
• git So you can actually download the code

Building the server

1. Clone the repository:

$ git clone https://codeberg.org/OpenThingies/openmood.git
$ cd openmood

2. Build and install the server

$ cargo install --path .

The binary is now available as openmood. To see how you can configure openmood, look at Configuration

Development

Requirements

• Rust toolchain (Stable)
  • rustfmt (nightly)
  • clippy (stable)
• docker-compose To spin up a pre-configured development environment.
• knope To generate changesets and changelogs
• Optional: cargo-watch this allows reloading the server on code changes.
• Optional: the sqlx-cli binary to apply migrations manually. (useful when running tests from a blank database)

Development Environment

Just run the docker compose up in the project to spin up all necessary dependencies including PgAdmin for convenience. NOTE: this is to be used for development purposes only

When using the docker compose, you can access a local postgres DB and a PgAdmin instance. They can be accessed with the following config:

• the postgres URI is: postgres://postgres:123456@localhost
• the credentials for PgAdmin are: dev@developer.dev with password 123456

Required Environment Variables

If you wish to set additional config options, go to Configuration

• OM_DB_URI must be set to whatever URI you use to connect to your postgres instance.
• OM_JWT_SECRET Can be set to any string during development.
• RUST_LOG This isn't required, but I recommend to set it to at least openmood=debug,actix=info,jealousy=info,sqlx=info.

Running the server

If you have cargo-watch installed, you can have it automatically reload the server as you change the code.

Note: using cargo watch may give minor issues if you are writing migrations, because they will be applied as the server reloads. If you run into this issue, the easiest thing to do is reset the database and reapply the migrations using sqlx migrate run --database-url [your db URI] or restarting the server and automatically apply the embedded migrations.

# with cargo-watch installed
cargo watch -cqx run

# without cargo-watch installed
cargo run

Configuration

All configuration is done via environment variables. What follows is a list of all possible environment variables one can set.

License

This project is licensed under the AGPL 3.0 license

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in openmood by you, shall be licensed as AGPL 3.0, without any additional terms or conditions.