mirror of
https://github.com/actualbudget/actual.git
synced 2026-03-11 20:44:32 -05:00
Documenting the server repo move (#629)
Documenting the repo move. I'll attach this doc to the Server readme so people are more informed https://deploy-preview-629.www.actualbudget.org/docs/actual-server-repo-move
This commit is contained in:
@@ -34,8 +34,8 @@ const sidebars = {
|
||||
link: {
|
||||
type: 'doc',
|
||||
id: 'tour/index',
|
||||
},
|
||||
items: [
|
||||
},
|
||||
items: [
|
||||
'tour/user-interface',
|
||||
'tour/budget',
|
||||
'tour/accounts',
|
||||
@@ -43,16 +43,16 @@ const sidebars = {
|
||||
'tour/schedules',
|
||||
'tour/payees',
|
||||
'tour/rules',
|
||||
],
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Getting Started',
|
||||
collapsible: false,
|
||||
items: [
|
||||
'getting-started/roadmap-for-new-users',
|
||||
'getting-started/envelope-budgeting',
|
||||
'getting-started/tracking-budget',
|
||||
'getting-started/roadmap-for-new-users',
|
||||
'getting-started/envelope-budgeting',
|
||||
'getting-started/tracking-budget',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Installation and Configuration',
|
||||
@@ -79,13 +79,16 @@ const sidebars = {
|
||||
type: 'category',
|
||||
label: 'Configuration',
|
||||
collapsible: false,
|
||||
items: [ 'config/index', 'config/https', 'advanced/http-header-auth', 'config/reverse-proxies' ],
|
||||
items: [
|
||||
'config/index',
|
||||
'config/https',
|
||||
'advanced/http-header-auth',
|
||||
'config/reverse-proxies',
|
||||
],
|
||||
},
|
||||
|
||||
],
|
||||
},
|
||||
|
||||
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Migration',
|
||||
@@ -93,19 +96,11 @@ const sidebars = {
|
||||
type: 'doc',
|
||||
id: 'migration/index',
|
||||
},
|
||||
items: [
|
||||
'migration/ynab4',
|
||||
'migration/nynab',
|
||||
],
|
||||
items: ['migration/ynab4', 'migration/nynab'],
|
||||
},
|
||||
|
||||
|
||||
],
|
||||
},
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Using Actual',
|
||||
@@ -135,7 +130,7 @@ const sidebars = {
|
||||
},
|
||||
'budgeting/multi-currency',
|
||||
'budgeting/joint-accounts',
|
||||
'advanced/restart'
|
||||
'advanced/restart',
|
||||
],
|
||||
},
|
||||
|
||||
@@ -143,8 +138,6 @@ const sidebars = {
|
||||
|
||||
'schedules',
|
||||
|
||||
|
||||
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Accounts & Transactions',
|
||||
@@ -186,7 +179,6 @@ const sidebars = {
|
||||
],
|
||||
},
|
||||
|
||||
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Reports',
|
||||
@@ -195,9 +187,7 @@ const sidebars = {
|
||||
type: 'doc',
|
||||
id: 'reports/index',
|
||||
},
|
||||
items: [
|
||||
'reports/custom-reports'
|
||||
],
|
||||
items: ['reports/custom-reports'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
@@ -216,8 +206,8 @@ const sidebars = {
|
||||
items: [
|
||||
'experimental/goal-templates',
|
||||
'experimental/monthly-cleanup',
|
||||
'experimental/oauth-auth',
|
||||
'experimental/multi-user'
|
||||
'experimental/oauth-auth',
|
||||
'experimental/multi-user',
|
||||
],
|
||||
},
|
||||
'getting-started/tips-tricks',
|
||||
@@ -243,24 +233,13 @@ const sidebars = {
|
||||
],
|
||||
},
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Help & Support',
|
||||
collapsible: false,
|
||||
items: [
|
||||
'faq',
|
||||
'actual-server-repo-move',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Troubleshooting',
|
||||
@@ -318,11 +297,9 @@ const sidebars = {
|
||||
type: 'category',
|
||||
label: 'Documentation',
|
||||
collapsible: false,
|
||||
items: [
|
||||
'contributing/writing-docs',
|
||||
],
|
||||
items: ['contributing/writing-docs'],
|
||||
},
|
||||
{
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Project Leadership',
|
||||
collapsible: false,
|
||||
|
||||
43
docs/actual-server-repo-move.md
Normal file
43
docs/actual-server-repo-move.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# 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](https://hub.docker.com/r/actualbudget/actual-server) and [Github's container registry](https://ghcr.io/actualbudget/actual-server) 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.Dockerfile``` located in the root of the repository. The ``` docker-compose.yml ``` is located in the ```/packages/sync-server``` directory.
|
||||
|
||||
|
||||
- **Q.** _I use the [Local Installation](https://actualbudget.org/docs/install/local). How do I keep up to date?_
|
||||
|
||||
**A.** Follow these instructions:
|
||||
1. Clone the [Actual repository](https://github.comactualbudget/actual). You can use the following command:
|
||||
```
|
||||
git clone https://github.com/actualbudget/actual.git
|
||||
```
|
||||
2. Navigate to the Actual project root directory:
|
||||
```
|
||||
cd actual
|
||||
```
|
||||
3. Install the required dependencies for the server:
|
||||
```
|
||||
yarn install:server
|
||||
```
|
||||
4. Run the server with:
|
||||
```
|
||||
yarn start:server
|
||||
```
|
||||
Reference in New Issue
Block a user