prehistoric-systems/bewcloud
1
0
Fork 0
mirror of https://github.com/bewcloud/bewcloud.git synced 2026-03-11 08:54:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reflect the fact the from source installations of bewCloud are supported in the README

Browse source 
Otherwise it looks like yet-another Docker-only service…
This commit is contained in:
Erin of Yukis 2025-12-06 15:28:06 +00:00 committed by GitHub
parent cfa21e6089
commit 3921b5137c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -10,11 +10,15 @@ If you're looking for the mobile app, it's at [`bewcloud-mobile`](https://github
## Self-host it!
### Using managed cloud
[![Buy managed cloud (1 year)](https://img.shields.io/badge/Buy%20managed%20cloud%20(1%20year)-51a4fb?style=for-the-badge)](https://buy.stripe.com/eVa01HgQk0Ap0eseVz)
[![Buy managed cloud (1 month)](https://img.shields.io/badge/Buy%20managed%20cloud%20(1%20month)-51a4fb?style=for-the-badge)](https://buy.stripe.com/fZu8wOb5RfIydj56FA1gs0J)
Or, to run on your own machine using Docker, start with these commands:
### Using Docker/Podman
To run on your own machine using Docker, start with these commands:
```sh
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)
@ -39,6 +43,20 @@ docker compose run --rm website bash -c "cd /app && make migrate-db" # initializ
>
> `1993:1993` above comes from deno's [docker image](https://github.com/denoland/deno_docker/blob/2abfe921484bdc79d11c7187a9d7b59537457c31/ubuntu.dockerfile#L20-L22) where `1993` is the default user id in it. It might change in the future since I don't control it.
### Outside of Docker (running from source)
Please refer to the [Development](#development) section for instruction on how to run directly from source.
This is only recommended for advanced users and will require manually switching to new versions of bewCloud as they are released:
```sh
git fetch origin # pull latest changes
git switch --detach $(git tag -l | sort | tail -n1) # switch to latest release
make migrate-db # run any missing database migrations
```
### Other ways
See the [Community Links](#community-links) section for alternative ways of running bewCloud yourself; please be aware these are not officially endorsed.
If you're interested in building/contributing, check the [Development section below](#development).
@ -73,8 +91,8 @@ These are the amazing entities or individuals who are sponsoring this project fo
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 # formats the code
make test # runs tests
make format # formats the code (development only)
make test # runs tests (development only)
```
### Other less-used commands