mirror of
https://github.com/actualbudget/actual.git
synced 2026-04-29 19:14:22 -05:00
Should be merged with: https://github.com/actualbudget/actual/pull/4569 **Changed pages:** - https://deploy-preview-661.www.actualbudget.org/docs/install/local - https://deploy-preview-661.www.actualbudget.org/docs/contributing/project-details/ - https://deploy-preview-661.www.actualbudget.org/docs/contributing/releasing/ - https://deploy-preview-661.www.actualbudget.org/docs/contributing/windows/ - https://deploy-preview-661.www.actualbudget.org/docs/actual-server-repo-move/
2.1 KiB
2.1 KiB
Actual Server repository move
In February 2025 the actual-server repository will be merged into the Actual repository.
The reasons for this change are as follows:
- Streamlines Development: Developers will only need to clone/sync one repo instead of two.
- Improves Debugging: It makes end-to-end debugging for server/client easier as they will be in the same workspace.
- Simplifies Desktop App Packaging: Enables the desktop app to embed the sync server.
- Ensures code consistency and reduces the maintenance burden.
- Simplifies the release process
Questions:
-
Q. I use Docker Hub/Github's container registry, how do I stay up to date?
A. We will continue to push images to Docker Hub and Github's container registry as usual.
-
Q. I build the docker image locally, can I still do that?
A. All of the docker files are still available. To build the sync server locally you can use the
sync-server.Dockerfilelocated in the root of the repository. Thedocker-compose.ymlis located in the/packages/sync-serverdirectory. -
Q. I use the Local Installation. How do I keep up to date?
A. Follow these instructions:
- Clone the Actual repository. You can use the following command:
git clone https://github.com/actualbudget/actual.git- Navigate to the Actual project root directory:
cd actual- Install the required dependencies for the server:
yarn install- Build the server:
yarn build:server- If you have a config.json file you will need to copy it into the following directory:
packages/sync-server- Copy over the data from your
actual-serverdirectory (user-files,server-files, and.migrate) into thepackages/sync-serverdirectory. - Run the server with:
yarn start:server