rafaelcaricio/actual-server
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add pikapods under one-click hosted (closes #20)

Browse source
This commit is contained in:
James Long 2022-05-19 22:50:35 -04:00
parent a09a028dc9
commit c86f1f5546
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,6 +2,9 @@ This is the main project to run [Actual](https://github.com/actualbudget/actual)
Join the [discord](https://discord.gg/pRYNYr4W5A)!
## Non-technical users
We are working on simpler one-button click deployments of Actual. This will reduce the friction for people not as comfortable with the command line. Some non-official options are listed at the bottom.
## Running
@ -26,10 +29,10 @@ docker build -t actual-server .
docker run -p 5006:5006 actual-server
```
## Deploying
### Fly.io
You should deploy your server so it's always running. We recommend [fly.io](https://fly.io) which makes it incredibly easy and provides a free plan.
[fly.io](https://fly.io) allows running the application directly and provides a free tier. You should be comfortable with using the command line to set it up though.
[Create an account](https://fly.io/app/sign-in). Although you are required to enter payment details, everything we do here will work on the free tier and you won't be charged.
@ -72,12 +75,11 @@ That's it! Actual will automatically check if the `/data` directory exists and u
_You can also configure the data dir with the `ACTUAL_USER_FILES` environment variable._
### PikaPods
Allows running Actual without using the command line via a pre-configured Docker image. Data is persisted and accessible via SFTP.
[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=actual)
### One-click hosting solutions
These are non-official methods of one-click solutions for running Actual. If you provide a service like this, feel free to open a PR and add it to this list. These run Actual via a Docker image.
* PikaPods: [Run on PikaPods](https://www.pikapods.com/pods?run=actual)
## Configuring the server URL
@ -86,3 +88,4 @@ The Actual app is totally separate from the server. In this project, they happen
The server could live on a completely different domain. You might setup Actual so that the app and server are running in completely separate places.
Since Actual doesn't know what server to use, the first thing it does is asks you for the server URL. If you are running this project, simply click "Use this domain" and it will automatically fill it in with the current domain. This works because we are serving the app and server in the same place.