Skip to content

Commit

Permalink
Clean up makefile + readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benbusby committed Dec 19, 2024
1 parent eb58111 commit e4c5838
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 23 deletions.
15 changes: 0 additions & 15 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,6 @@ backend: web
cli:
go build -ldflags="-s -w" -tags yeetfile -o yeetfile ./cli

deploy:
GOOS=linux GOARCH=amd64 go build \
-tags yeetfile-server \
-o yeetfile-server-deploy \
./backend
mv yeetfile-server-deploy ansible/roles/yeetfile/files/

deploy_dev: deploy
test -s ./ansible/roles/yeetfile/files/dev.env || { echo "dev.env not in ansible/roles/yeetfile/files -- exiting..."; exit 1; }
ansible-playbook -i ansible/inventory/dev.yml ansible/deploy.yml

deploy_prod: deploy
test -s ./ansible/roles/yeetfile/files/prod.env || { echo "prod.env not in ansible/roles/yeetfile/files -- exiting..."; exit 1; }
ansible-playbook -i ansible/inventory/prod.yml deploy.yml

clean:
rm -f yeetfile-web
rm -f yeetfile
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,20 @@ Contents

## About

YeetFile is a file vault and file/text transferring service, with both a [web](https://yeetfile.com) and
[CLI client](https://github.com/benbusby/yeetfile/releases) officially supported. All content is encrypted
locally, and the server is incapable of decrypting any transmitted content.
YeetFile is a file vault and file/text transferring service, with both a
[web](https://yeetfile.com) and [CLI
client](https://github.com/benbusby/yeetfile/releases) officially supported.
All content is encrypted locally, and the server is incapable of decrypting any
transmitted content.

## Features

### YeetFile Vault

![vault example](https://docs.yeetfile.com/images/vault-example.png)

- File storage + folder creation
- File + folder sharing w/ YeetFile users
- File and password storage + folder creation
- File/password/folder sharing w/ YeetFile users
- Read/write permissions per user
- No upload size limit

Expand Down Expand Up @@ -99,9 +101,10 @@ You can quickly create your own instance of YeetFile using `docker compose`:

`docker compose up`

This will create the Postgres db and the server running on http://localhost:8090. You can modify the docker-compose.yml
to use an external data volume by running `docker volume create --name=yeetfile_data` and including the following in
your docker-compose.yml:
This will create the Postgres db and the server running on
http://localhost:8090. You can modify the docker-compose.yml to use an external
data volume by running `docker volume create --name=yeetfile_data` and
including the following in your docker-compose.yml:

```
volumes:
Expand Down Expand Up @@ -201,6 +204,7 @@ paid account upgrades.
| YEETFILE_BTCPAY_SERVER_URL | The URL of the BTCPay instance |
| YEETFILE_STRIPE_KEY | The Stripe secret key |
| YEETFILE_STRIPE_WEBHOOK_SECRET | The Stripe webhook secret |
| YEETFILE_UPGRADES_JSON | A JSON array describing the available account upgrades (see shared.Upgrade struct) |

## Support

Expand Down

0 comments on commit e4c5838

Please sign in to comment.