This is the bewCloud app built using Fresh and deployed using docker compose.
If you're looking for the desktop sync app, it's at bewcloud-desktop.
If you're looking for the mobile app, it's at bewcloud-mobile.
Or, to run on your own machine, start with these commands:
mkdir data-files data-radicale radicale-config # local directories for storing user-uploaded files, radicale data, and radicale config (these last two are necessary only if you're using CalDav/CardDav/Contacts)Now, download/copy the following configuration files (and tweak their contents as necessary, though no changes should yield a working — but very unsafe — setup):
docker-compose.yml.env.sampleand save it as.envbewcloud.config.sample.tsand save it asbewcloud.config.tsradicale-config/configand save it asradicale-config/config(necessary only if you're using CalDav/CardDav/Contacts)
Finally, run these commands:
docker compose up -d # makes the app available at http://localhost:8000
docker compose run --rm website bash -c "cd /app && make migrate-db" # initializes/updates the database (only needs to be executed the first time and on any data updates)Note
If you run into permission issues, you can try running sudo chown -R 1993:1993 data-files to fix them.
1993:1993 above comes from deno's docker image where 1993 is the default user id in it. It might change in the future since I don't control it.
If you're interested in building/contributing (or just running the app locally), check the Development section below.
See the Community Links section for alternative ways of running bewCloud yourself.
Important
Even with signups disabled (config.auth.allowSignups=false), the first signup will work and become an admin.
These are the amazing entities or individuals who are sponsoring this project for this current month. If you'd like to show up here, check the GitHub Sponsors page or make a donation above $50 ($100 to show up on the website)!
Important
Don't forget to set up your .env file based on .env.sample.
Don't forget to set up your bewcloud.config.ts file based on bewcloud.config.sample.ts.
- This was tested with
Deno's version stated in the.dvmrcfile, though other versions may work. - For the postgres dependency (used when running locally or in CI), you should have
Dockeranddocker composeinstalled.
docker compose -f docker-compose.dev.yml up # (optional) runs docker with postgres, locally
make migrate-db # runs any missing database migrations
make start # runs the app
make format # (optional) formats the code (if you're interested in contributing)
make test # (optional) runs tests (if you're interested in contributing)make exec-db # runs psql inside the postgres container, useful for running direct development queries like `DROP DATABASE "bewcloud"; CREATE DATABASE "bewcloud";`
make build # generates all static files for production deploy- Routes are defined at
routes/. - Static files are defined at
static/. - Frontend-only components are defined at
components/. - Isomorphic components are defined at
islands/. - Cron jobs are defined at
crons/. - Reusable bits of code are defined at
lib/. - Database migrations are defined at
db-migrations/.
Just push to the main branch.
Check the FAQ for answers to common questions, like private calendar and file sharing, or .env-based configuration.
Check the website for screenshots or the YouTube channel for 1-minute demos.
These are not officially endorsed, but are alternative ways of running bewCloud.
bewcloud-nixosby @ntninja exposes bewCloud as a NixOS integration as an alternative to using Docker or running the app locally.- For installation and known limitations, please see its README.