├── .env.sample ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── help-wanted.md └── workflows │ ├── testing-with-stable-client-and-server.yml │ └── testing-with-updating-client-and-server.yml ├── .gitignore ├── LICENSE.txt ├── README.md ├── data ├── .gitkeep ├── import │ └── .gitkeep └── uploads │ └── .gitkeep ├── docker-compose.yml ├── docker ├── api-gateway.env.sample ├── auth.env.sample ├── files.env.sample ├── localstack_bootstrap.sh └── revisions.env.sample └── server.sh /.env.sample: -------------------------------------------------------------------------------- 1 | LOG_LEVEL=info 2 | NODE_ENV=development 3 | VERSION=local 4 | 5 | AUTH_JWT_SECRET=auth_jwt_secret 6 | 7 | EXPOSED_PORT=3000 8 | 9 | DB_HOST=db 10 | DB_PORT=3306 11 | DB_USERNAME=std_notes_user 12 | DB_PASSWORD=changeme123 13 | DB_DATABASE=standard_notes_db 14 | DB_DEBUG_LEVEL=all # "all" | "query" | "schema" | "error" | "warn" | "info" | "log" | "migration" 15 | DB_MIGRATIONS_PATH=dist/migrations/*.js 16 | 17 | REDIS_URL=redis://cache 18 | 19 | # Localstack Setup (Do not change unless you want to use your real AWS account) 20 | SNS_TOPIC_ARN="arn:aws:sns:us-east-1:000000000000:syncing-server-local-topic" 21 | SNS_ENDPOINT="http://localstack:4566" 22 | SNS_DISABLE_SSL=true 23 | SNS_SECRET_ACCESS_KEY="x" 24 | SNS_ACCESS_KEY_ID="x" 25 | SNS_AWS_REGION="us-east-1" 26 | SQS_QUEUE_URL="http://localstack:4566/000000000000/syncing-server-local-queue" 27 | SQS_AWS_REGION="us-east-1" 28 | SQS_ACCESS_KEY_ID="x" 29 | SQS_SECRET_ACCESS_KEY="x" 30 | SQS_ENDPOINT="http://localstack:4566" 31 | 32 | S3_AWS_REGION= 33 | S3_BACKUP_BUCKET_NAME= 34 | 35 | REDIS_EVENTS_CHANNEL=events 36 | 37 | AUTH_SERVER_URL=http://auth:3000 38 | 39 | EMAIL_ATTACHMENT_MAX_BYTE_SIZE=10485760 40 | 41 | REVISIONS_FREQUENCY=300 42 | 43 | # (Optional) New Relic Setup 44 | NEW_RELIC_ENABLED=false 45 | NEW_RELIC_APP_NAME="Syncing Server JS" 46 | NEW_RELIC_LICENSE_KEY= 47 | NEW_RELIC_NO_CONFIG_FILE=true 48 | NEW_RELIC_DISTRIBUTED_TRACING_ENABLED=false 49 | NEW_RELIC_LOG_ENABLED=false 50 | NEW_RELIC_LOG_LEVEL=info 51 | 52 | # File upload path (relative to root directory) 53 | FILE_UPLOAD_PATH=data/uploads 54 | 55 | # File uploads 56 | VALET_TOKEN_SECRET=change-me-! 57 | EXPOSED_FILES_PORT=3125 58 | # Public-facing URL of the Files server. Endpoint on which clients will access it. 59 | FILES_SERVER_URL=http://localhost:3125 60 | 61 | # Revisions Database 62 | REVISIONS_DB_HOST=revisions-db 63 | REVISIONS_DB_PORT=3306 64 | REVISIONS_DB_USERNAME=revisions 65 | REVISIONS_DB_PASSWORD=changeme123 66 | REVISIONS_DB_DATABASE=revisions 67 | REVISIONS_DB_DEBUG_LEVEL=all # "all" | "query" | "schema" | "error" | "warn" | "info" | "log" | "migration" 68 | REVISIONS_DB_MIGRATIONS_PATH=dist/migrations/*.js 69 | 70 | SYNCING_SERVER_JS_IMAGE_TAG=latest 71 | API_GATEWAY_IMAGE_TAG=latest 72 | AUTH_IMAGE_TAG=latest 73 | FILES_IMAGE_TAG=latest 74 | REVISIONS_IMAGE_TAG=latest 75 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: "[BUG] ..." 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Service Versions (please complete the following information):** 11 | Paste the output of `./server.sh version`. For example: 12 | ``` 13 | Container Repository Tag Image Id Size 14 | ------------------------------------------------------------------------------------------------------------ 15 | api-gateway-standalone standardnotes/api-gateway 1.25.1 b29b29a5a88c 630.8 MB 16 | auth-standalone standardnotes/auth 1.22.1 3ae071814b36 850.2 MB 17 | auth-worker-standalone standardnotes/auth 1.22.1 3ae071814b36 850.2 MB 18 | cache-standalone redis 6.0-alpine 0003e5fe462a 31.31 MB 19 | db-standalone mysql 5.6 8d06d2d16232 302.5 MB 20 | syncing-server-js-standalone standardnotes/syncing-server-js 1.42.1 7543b99652cd 964.5 MB 21 | syncing-server-js-worker-standalone standardnotes/syncing-server-js 1.42.1 7543b99652cd 964.5 MB 22 | ``` 23 | 24 | **Describe the bug** 25 | A clear and concise description of what the bug is. 26 | 27 | **To Reproduce** 28 | Steps to reproduce the behavior: 29 | 1. Go to '...' 30 | 2. Click on '....' 31 | 3. Scroll down to '....' 32 | 4. See error 33 | 34 | **Expected behavior** 35 | A clear and concise description of what you expected to happen. 36 | 37 | **Logs** 38 | If applicable, add logs to help debug your problem. 39 | 40 | **Screenshots** 41 | If applicable, add screenshots to help explain your problem. 42 | 43 | **Additional context** 44 | Add any other context about the problem here. 45 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/help-wanted.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Help Wanted 3 | about: Create a request for helping out with the self hosted setup 4 | title: '' 5 | labels: help wanted 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Service Versions (please complete the following information):** 11 | Paste the output of `./server.sh version`. For example: 12 | ``` 13 | Container Repository Tag Image Id Size 14 | ------------------------------------------------------------------------------------------------------------ 15 | api-gateway-standalone standardnotes/api-gateway 1.25.1 b29b29a5a88c 630.8 MB 16 | auth-standalone standardnotes/auth 1.22.1 3ae071814b36 850.2 MB 17 | auth-worker-standalone standardnotes/auth 1.22.1 3ae071814b36 850.2 MB 18 | cache-standalone redis 6.0-alpine 0003e5fe462a 31.31 MB 19 | db-standalone mysql 5.6 8d06d2d16232 302.5 MB 20 | syncing-server-js-standalone standardnotes/syncing-server-js 1.42.1 7543b99652cd 964.5 MB 21 | syncing-server-js-worker-standalone standardnotes/syncing-server-js 1.42.1 7543b99652cd 964.5 MB 22 | ``` 23 | 24 | **Describe the issue** 25 | A clear and concise description of what the issue is. 26 | 27 | **Logs** 28 | If applicable, add logs to help debug your problem. 29 | -------------------------------------------------------------------------------- /.github/workflows/testing-with-stable-client-and-server.yml: -------------------------------------------------------------------------------- 1 | name: Testing With Stable Client And Server 2 | 3 | on: 4 | schedule: 5 | - cron: '0 */12 * * *' 6 | workflow_dispatch: 7 | push: 8 | branches: [ main ] 9 | 10 | jobs: 11 | e2e-tests: 12 | runs-on: ubuntu-latest 13 | 14 | services: 15 | snjs: 16 | image: standardnotes/snjs 17 | ports: 18 | - 9001:9001 19 | mock-event-publisher: 20 | image: standardnotes/mock-event-publisher 21 | ports: 22 | - 3124:3000 23 | env: 24 | LOG_LEVEL: debug 25 | NODE_ENV: production 26 | VERSION: snjs-test 27 | SNS_TOPIC_ARN: arn:aws:sns:us-east-1:000000000000:payments-local-topic 28 | SNS_ENDPOINT: http://localstack:4566 29 | SNS_DISABLE_SSL: true 30 | SNS_SECRET_ACCESS_KEY: x 31 | SNS_ACCESS_KEY_ID: x 32 | SNS_AWS_REGION: us-east-1 33 | NEW_RELIC_ENABLED: false 34 | options: >- 35 | --name "mock-event-publisher" 36 | 37 | steps: 38 | - uses: actions/checkout@v3 39 | with: 40 | fetch-depth: 2 41 | - name: Checkout On Previous Commit 42 | run: git checkout HEAD~1 43 | - name: Set up Node 44 | uses: actions/setup-node@v3 45 | - name: Install Headless Chrome 46 | run: yarn global add mocha-headless-chrome 47 | - name: Initialize Default Configuration 48 | run: | 49 | ./server.sh setup 50 | ./server.sh generate-keys 51 | - name: Set Database Passwords 52 | run: | 53 | sed -i "s/REVISIONS_DB_PASSWORD=.*/REVISIONS_DB_PASSWORD=changeme123/g" .env 54 | sed -i "s/DB_PASSWORD=.*/DB_PASSWORD=changeme123/g" .env 55 | - name: Start Stable Server 56 | run: ./server.sh start 57 | env: 58 | EXPOSED_PORT: 3123 59 | - name: Wait for Startup 60 | run: ./server.sh wait-for-startup 61 | - name: Checkout On Latest Commit 62 | run: git switch - 63 | - name: Initialize Default Configuration on Latest Commit 64 | run: | 65 | ./server.sh restore-config-defaults 66 | ./server.sh generate-keys 67 | - name: Set Database Passwords 68 | run: | 69 | sed -i "s/REVISIONS_DB_PASSWORD=.*/REVISIONS_DB_PASSWORD=changeme123/g" .env 70 | sed -i "s/DB_PASSWORD=.*/DB_PASSWORD=changeme123/g" .env 71 | - name: Setup shorter session TTLs for testing 72 | run: | 73 | sed -i "s/ACCESS_TOKEN_AGE=.*/ACCESS_TOKEN_AGE=4/g" docker/auth.env 74 | sed -i "s/REFRESH_TOKEN_AGE=.*/REFRESH_TOKEN_AGE=10/g" docker/auth.env 75 | sed -i "s/EPHEMERAL_SESSION_AGE=.*/EPHEMERAL_SESSION_AGE=300/g" docker/auth.env 76 | - name: Setup shorter revisions creating frequency 77 | run: | 78 | sed -i "s/REVISIONS_FREQUENCY=.*/REVISIONS_FREQUENCY=5/g" .env 79 | - name: Setup debug log levels 80 | run: | 81 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/auth.env 82 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/api-gateway.env 83 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/files.env 84 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/revisions.env 85 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" .env 86 | - name: Start Updating Server 87 | run: ./server.sh update 88 | env: 89 | EXPOSED_PORT: 3123 90 | - name: Wait for Startup 91 | run: ./server.sh wait-for-startup 92 | - name: Connect external containers to self-hosted network 93 | run: docker network connect --alias mock-event-publisher standardnotes_self_hosted mock-event-publisher 94 | - name: Test 95 | run: ./server.sh test 96 | -------------------------------------------------------------------------------- /.github/workflows/testing-with-updating-client-and-server.yml: -------------------------------------------------------------------------------- 1 | name: Testing With Updating Client And Updating Server 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | syncing_server_js_image_tag: 7 | type: string 8 | default: latest 9 | description: The Docker image tag used for Syncing Server JS container 10 | api_gateway_image_tag: 11 | type: string 12 | default: latest 13 | description: The Docker image tag used for Api Gateway container 14 | auth_image_tag: 15 | type: string 16 | default: latest 17 | description: The Docker image tag used for Auth container 18 | files_image_tag: 19 | type: string 20 | default: latest 21 | description: The Docker image tag used for Files container 22 | revisions_image_tag: 23 | type: string 24 | default: latest 25 | description: The Docker image tag used for Revisions container 26 | snjs_image_tag: 27 | type: string 28 | default: latest 29 | description: The Docker image tag used for SNJS container 30 | 31 | jobs: 32 | e2e-tests: 33 | runs-on: ubuntu-latest 34 | 35 | services: 36 | snjs: 37 | image: standardnotes/snjs:${{ inputs.snjs_image_tag }} 38 | ports: 39 | - 9001:9001 40 | mock-event-publisher: 41 | image: standardnotes/mock-event-publisher 42 | ports: 43 | - 3124:3000 44 | env: 45 | LOG_LEVEL: debug 46 | NODE_ENV: production 47 | VERSION: snjs-test 48 | SNS_TOPIC_ARN: arn:aws:sns:us-east-1:000000000000:payments-local-topic 49 | SNS_ENDPOINT: http://localstack:4566 50 | SNS_DISABLE_SSL: true 51 | SNS_SECRET_ACCESS_KEY: x 52 | SNS_ACCESS_KEY_ID: x 53 | SNS_AWS_REGION: us-east-1 54 | NEW_RELIC_ENABLED: false 55 | options: >- 56 | --name "mock-event-publisher" 57 | 58 | steps: 59 | - uses: actions/checkout@v3 60 | with: 61 | fetch-depth: 2 62 | - name: Checkout On Previous Commit 63 | run: git checkout HEAD~1 64 | - name: Set up Node 65 | uses: actions/setup-node@v3 66 | - name: Install Headless Chrome 67 | run: yarn global add mocha-headless-chrome 68 | - name: Initialize Default Configuration 69 | run: | 70 | ./server.sh setup 71 | ./server.sh generate-keys 72 | - name: Set Database Passwords 73 | run: | 74 | sed -i "s/REVISIONS_DB_PASSWORD=.*/REVISIONS_DB_PASSWORD=changeme123/g" .env 75 | sed -i "s/DB_PASSWORD=.*/DB_PASSWORD=changeme123/g" .env 76 | - name: Start Stable Server 77 | run: ./server.sh start 78 | env: 79 | EXPOSED_PORT: 3123 80 | SYNCING_SERVER_JS_IMAGE_TAG: latest 81 | API_GATEWAY_IMAGE_TAG: latest 82 | AUTH_IMAGE_TAG: latest 83 | FILES_IMAGE_TAG: latest 84 | REVISIONS_IMAGE_TAG: latest 85 | - name: Wait for Startup 86 | run: ./server.sh wait-for-startup 87 | - name: Checkout On Latest Commit 88 | run: git switch - 89 | - name: Initialize Default Configuration on Latest Commit 90 | run: | 91 | ./server.sh restore-config-defaults 92 | ./server.sh generate-keys 93 | - name: Set Database Passwords 94 | run: | 95 | sed -i "s/REVISIONS_DB_PASSWORD=.*/REVISIONS_DB_PASSWORD=changeme123/g" .env 96 | sed -i "s/DB_PASSWORD=.*/DB_PASSWORD=changeme123/g" .env 97 | - name: Setup shorter session TTLs for testing 98 | run: | 99 | sed -i "s/ACCESS_TOKEN_AGE=.*/ACCESS_TOKEN_AGE=4/g" docker/auth.env 100 | sed -i "s/REFRESH_TOKEN_AGE=.*/REFRESH_TOKEN_AGE=10/g" docker/auth.env 101 | sed -i "s/EPHEMERAL_SESSION_AGE=.*/EPHEMERAL_SESSION_AGE=300/g" docker/auth.env 102 | - name: Setup shorter revisions creating frequency 103 | run: | 104 | sed -i "s/REVISIONS_FREQUENCY=.*/REVISIONS_FREQUENCY=5/g" .env 105 | - name: Setup debug log levels 106 | run: | 107 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/auth.env 108 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/api-gateway.env 109 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/files.env 110 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" docker/revisions.env 111 | sed -i "s/LOG_LEVEL=.*/LOG_LEVEL=debug/g" .env 112 | - name: Start Updating Server 113 | run: ./server.sh update 114 | env: 115 | EXPOSED_PORT: 3123 116 | SYNCING_SERVER_JS_IMAGE_TAG: ${{ inputs.syncing_server_js_image_tag }} 117 | API_GATEWAY_IMAGE_TAG: ${{ inputs.api_gateway_image_tag }} 118 | AUTH_IMAGE_TAG: ${{ inputs.auth_image_tag }} 119 | FILES_IMAGE_TAG: ${{ inputs.files_image_tag }} 120 | REVISIONS_IMAGE_TAG: ${{ inputs.revisions_image_tag }} 121 | - name: Wait for Startup 122 | run: ./server.sh wait-for-startup 123 | - name: Connect external containers to self-hosted network 124 | run: docker network connect --alias mock-event-publisher standardnotes_self_hosted mock-event-publisher 125 | - name: Test 126 | run: ./server.sh test 127 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | 3 | # MySQL & Redis data 4 | data/mysql 5 | data/revisions-db 6 | data/redis 7 | data/import/*.sql 8 | 9 | # Ignore ENV variables config 10 | .env 11 | auth.env 12 | api-gateway.env 13 | syncing-server.env 14 | files.env 15 | revisions.env 16 | 17 | # File Uploads 18 | data/uploads/* 19 | !data/uploads/.gitkeep 20 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Moved to this repository: https://github.com/standardnotes/server 2 | 3 | Learn about our new more efficient self-hosting setup: https://standardnotes.com/blog/introducing-self-hosting-v2 4 | 5 | Head over to our [official docs](https://standardnotes.com/help/self-hosting/docker) to get started. 6 | -------------------------------------------------------------------------------- /data/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/standardnotes/self-hosted/c7222a8381b119f71be4349df876c6790ad42045/data/.gitkeep -------------------------------------------------------------------------------- /data/import/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/standardnotes/self-hosted/c7222a8381b119f71be4349df876c6790ad42045/data/import/.gitkeep -------------------------------------------------------------------------------- /data/uploads/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/standardnotes/self-hosted/c7222a8381b119f71be4349df876c6790ad42045/data/uploads/.gitkeep -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | syncing-server-js: 3 | image: standardnotes/syncing-server-js:${SYNCING_SERVER_JS_IMAGE_TAG} 4 | container_name: syncing-server-js-self-hosted 5 | depends_on: 6 | - db 7 | - cache 8 | entrypoint: [ 9 | "./wait-for.sh", "db", "3306", 10 | "./wait-for.sh", "cache", "6379", 11 | "./wait-for.sh", "localstack", "4566", 12 | "./docker/entrypoint.sh", "start-web" 13 | ] 14 | env_file: .env 15 | environment: 16 | PORT: 3000 17 | FILE_UPLOAD_PATH: 'uploads/${FILE_UPLOAD_PATH}' 18 | volumes: 19 | - ./${FILE_UPLOAD_PATH}:/workspace/packages/syncing-server/uploads/${FILE_UPLOAD_PATH} 20 | restart: on-failure 21 | networks: 22 | - standardnotes_self_hosted 23 | 24 | syncing-server-js-worker: 25 | image: standardnotes/syncing-server-js:${SYNCING_SERVER_JS_IMAGE_TAG} 26 | container_name: syncing-server-js-worker-self-hosted 27 | depends_on: 28 | - db 29 | - cache 30 | - syncing-server-js 31 | entrypoint: [ 32 | "./wait-for.sh", "db", "3306", 33 | "./wait-for.sh", "cache", "6379", 34 | "./wait-for.sh", "syncing-server-js", "3000", 35 | "./docker/entrypoint.sh", "start-worker" 36 | ] 37 | env_file: .env 38 | environment: 39 | PORT: 3000 40 | FILE_UPLOAD_PATH: 'uploads/${FILE_UPLOAD_PATH}' 41 | volumes: 42 | - ./${FILE_UPLOAD_PATH}:/workspace/packages/syncing-server/uploads/${FILE_UPLOAD_PATH} 43 | restart: on-failure 44 | networks: 45 | - standardnotes_self_hosted 46 | 47 | api-gateway: 48 | image: standardnotes/api-gateway:${API_GATEWAY_IMAGE_TAG} 49 | container_name: api-gateway-self-hosted 50 | depends_on: 51 | - auth 52 | - syncing-server-js 53 | env_file: docker/api-gateway.env 54 | ports: 55 | - ${EXPOSED_PORT}:3000 56 | environment: 57 | PORT: 3000 58 | AUTH_JWT_SECRET: '${AUTH_JWT_SECRET}' 59 | REDIS_URL: '${REDIS_URL}' 60 | FILES_SERVER_URL: '${FILES_SERVER_URL}' 61 | entrypoint: [ 62 | "./wait-for.sh", "auth", "3000", 63 | "./wait-for.sh", "syncing-server-js", "3000", 64 | "./wait-for.sh", "files", "3000", 65 | "./wait-for.sh", "revisions", "3000", 66 | "./docker/entrypoint.sh", "start-web" 67 | ] 68 | restart: on-failure 69 | networks: 70 | - standardnotes_self_hosted 71 | 72 | auth: 73 | image: standardnotes/auth:${AUTH_IMAGE_TAG} 74 | container_name: auth-self-hosted 75 | depends_on: 76 | - db 77 | - cache 78 | - syncing-server-js 79 | entrypoint: [ 80 | "./wait-for.sh", "db", "3306", 81 | "./wait-for.sh", "cache", "6379", 82 | "./wait-for.sh", "localstack", "4566", 83 | "./wait-for.sh", "syncing-server-js", "3000", 84 | "./docker/entrypoint.sh", "start-web" 85 | ] 86 | env_file: docker/auth.env 87 | environment: 88 | PORT: 3000 89 | DB_HOST: '${DB_HOST}' 90 | DB_PORT: '${DB_PORT}' 91 | DB_DATABASE: '${DB_DATABASE}' 92 | DB_USERNAME: '${DB_USERNAME}' 93 | DB_PASSWORD: '${DB_PASSWORD}' 94 | DB_DEBUG_LEVEL: '${DB_DEBUG_LEVEL}' 95 | DB_MIGRATIONS_PATH: '${DB_MIGRATIONS_PATH}' 96 | REDIS_URL: '${REDIS_URL}' 97 | AUTH_JWT_SECRET: '${AUTH_JWT_SECRET}' 98 | VALET_TOKEN_SECRET: '${VALET_TOKEN_SECRET}' 99 | restart: on-failure 100 | networks: 101 | - standardnotes_self_hosted 102 | 103 | auth-worker: 104 | image: standardnotes/auth:${AUTH_IMAGE_TAG} 105 | container_name: auth-worker-self-hosted 106 | depends_on: 107 | - db 108 | - cache 109 | - auth 110 | entrypoint: [ 111 | "./wait-for.sh", "db", "3306", 112 | "./wait-for.sh", "cache", "6379", 113 | "./wait-for.sh", "auth", "3000", 114 | "./docker/entrypoint.sh", "start-worker" 115 | ] 116 | env_file: docker/auth.env 117 | environment: 118 | PORT: 3000 119 | DB_HOST: '${DB_HOST}' 120 | DB_PORT: '${DB_PORT}' 121 | DB_DATABASE: '${DB_DATABASE}' 122 | DB_USERNAME: '${DB_USERNAME}' 123 | DB_PASSWORD: '${DB_PASSWORD}' 124 | DB_DEBUG_LEVEL: '${DB_DEBUG_LEVEL}' 125 | DB_MIGRATIONS_PATH: '${DB_MIGRATIONS_PATH}' 126 | REDIS_URL: '${REDIS_URL}' 127 | AUTH_JWT_SECRET: '${AUTH_JWT_SECRET}' 128 | VALET_TOKEN_SECRET: '${VALET_TOKEN_SECRET}' 129 | restart: on-failure 130 | networks: 131 | - standardnotes_self_hosted 132 | 133 | files: 134 | image: standardnotes/files:${FILES_IMAGE_TAG} 135 | container_name: files-self-hosted 136 | entrypoint: [ 137 | "./wait-for.sh", "db", "3306", 138 | "./wait-for.sh", "cache", "6379", 139 | "./wait-for.sh", "localstack", "4566", 140 | "./docker/entrypoint.sh", "start-web" 141 | ] 142 | ports: 143 | - ${EXPOSED_FILES_PORT}:3000 144 | env_file: docker/files.env 145 | environment: 146 | FILE_UPLOAD_PATH: 'uploads/${FILE_UPLOAD_PATH}' 147 | VALET_TOKEN_SECRET: '${VALET_TOKEN_SECRET}' 148 | volumes: 149 | - ./${FILE_UPLOAD_PATH}:/workspace/packages/files/uploads/${FILE_UPLOAD_PATH} 150 | restart: on-failure 151 | networks: 152 | - standardnotes_self_hosted 153 | 154 | files-worker: 155 | image: standardnotes/files:${FILES_IMAGE_TAG} 156 | container_name: files-worker-self-hosted 157 | depends_on: 158 | - files 159 | entrypoint: [ 160 | "./wait-for.sh", "files", "3000", 161 | "./wait-for.sh", "localstack", "4566", 162 | "./docker/entrypoint.sh", "start-worker" 163 | ] 164 | env_file: docker/files.env 165 | environment: 166 | FILE_UPLOAD_PATH: 'uploads/${FILE_UPLOAD_PATH}' 167 | VALET_TOKEN_SECRET: '${VALET_TOKEN_SECRET}' 168 | volumes: 169 | - ./${FILE_UPLOAD_PATH}:/workspace/packages/files/uploads/${FILE_UPLOAD_PATH} 170 | restart: on-failure 171 | networks: 172 | - standardnotes_self_hosted 173 | 174 | revisions: 175 | image: standardnotes/revisions:${REVISIONS_IMAGE_TAG} 176 | container_name: revisions-self-hosted 177 | entrypoint: [ 178 | "./wait-for.sh", "syncing-server-js", "3000", 179 | "./wait-for.sh", "revisions-db", "3306", 180 | "./wait-for.sh", "localstack", "4566", 181 | "./docker/entrypoint.sh", "start-web" 182 | ] 183 | env_file: docker/revisions.env 184 | environment: 185 | PORT: 3000 186 | AUTH_JWT_SECRET: '${AUTH_JWT_SECRET}' 187 | DB_HOST: '${REVISIONS_DB_HOST}' 188 | DB_PORT: '${REVISIONS_DB_PORT}' 189 | DB_DATABASE: '${REVISIONS_DB_DATABASE}' 190 | DB_USERNAME: '${REVISIONS_DB_USERNAME}' 191 | DB_PASSWORD: '${REVISIONS_DB_PASSWORD}' 192 | DB_DEBUG_LEVEL: '${REVISIONS_DB_DEBUG_LEVEL}' 193 | DB_MIGRATIONS_PATH: '${REVISIONS_DB_MIGRATIONS_PATH}' 194 | restart: on-failure 195 | networks: 196 | - standardnotes_self_hosted 197 | 198 | revisions-worker: 199 | image: standardnotes/revisions:${REVISIONS_IMAGE_TAG} 200 | container_name: revisions-worker-self-hosted 201 | entrypoint: [ 202 | "./wait-for.sh", "revisions", "3000", 203 | "./docker/entrypoint.sh", "start-worker" 204 | ] 205 | env_file: docker/revisions.env 206 | environment: 207 | PORT: 3000 208 | AUTH_JWT_SECRET: '${AUTH_JWT_SECRET}' 209 | DB_HOST: '${REVISIONS_DB_HOST}' 210 | DB_PORT: '${REVISIONS_DB_PORT}' 211 | DB_DATABASE: '${REVISIONS_DB_DATABASE}' 212 | DB_USERNAME: '${REVISIONS_DB_USERNAME}' 213 | DB_PASSWORD: '${REVISIONS_DB_PASSWORD}' 214 | DB_DEBUG_LEVEL: '${REVISIONS_DB_DEBUG_LEVEL}' 215 | DB_MIGRATIONS_PATH: '${REVISIONS_DB_MIGRATIONS_PATH}' 216 | FILE_UPLOAD_PATH: 'uploads/${FILE_UPLOAD_PATH}' 217 | volumes: 218 | - ./${FILE_UPLOAD_PATH}:/workspace/packages/revisions/uploads/${FILE_UPLOAD_PATH} 219 | restart: on-failure 220 | networks: 221 | - standardnotes_self_hosted 222 | 223 | db: 224 | image: mysql:5.6 225 | container_name: db-self-hosted 226 | environment: 227 | MYSQL_DATABASE: '${DB_DATABASE}' 228 | MYSQL_USER: '${DB_USERNAME}' 229 | MYSQL_PASSWORD: '${DB_PASSWORD}' 230 | MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}' 231 | expose: 232 | - 3306 233 | restart: unless-stopped 234 | command: --default-authentication-plugin=mysql_native_password --character-set-server=utf8 --collation-server=utf8_general_ci 235 | volumes: 236 | - ./data/mysql:/var/lib/mysql 237 | - ./data/import:/docker-entrypoint-initdb.d 238 | networks: 239 | - standardnotes_self_hosted 240 | 241 | revisions-db: 242 | image: mysql:8 243 | container_name: revisions-db-self-hosted 244 | environment: 245 | MYSQL_DATABASE: '${REVISIONS_DB_DATABASE}' 246 | MYSQL_USER: '${REVISIONS_DB_USERNAME}' 247 | MYSQL_PASSWORD: '${REVISIONS_DB_PASSWORD}' 248 | MYSQL_ROOT_PASSWORD: '${REVISIONS_DB_PASSWORD}' 249 | expose: 250 | - 3306 251 | restart: unless-stopped 252 | command: --default-authentication-plugin=mysql_native_password --character-set-server=utf8 --collation-server=utf8_general_ci 253 | volumes: 254 | - ./data/revisions-db:/var/lib/mysql 255 | networks: 256 | - standardnotes_self_hosted 257 | 258 | cache: 259 | image: redis:6.0-alpine 260 | container_name: cache-self-hosted 261 | volumes: 262 | - ./data/redis/:/data 263 | expose: 264 | - 6379 265 | restart: unless-stopped 266 | networks: 267 | - standardnotes_self_hosted 268 | 269 | localstack: 270 | image: localstack/localstack:1.3 271 | container_name: localstack-self-hosted 272 | expose: 273 | - 4566 274 | restart: unless-stopped 275 | environment: 276 | - SERVICES=sns,sqs 277 | - DOCKER_HOST=unix:///var/run/docker.sock 278 | - HOSTNAME_EXTERNAL=localstack 279 | volumes: 280 | - ./docker/localstack_bootstrap.sh:/etc/localstack/init/ready.d/localstack_bootstrap.sh 281 | - /var/run/docker.sock:/var/run/docker.sock 282 | networks: 283 | - standardnotes_self_hosted 284 | 285 | networks: 286 | standardnotes_self_hosted: 287 | name: standardnotes_self_hosted 288 | -------------------------------------------------------------------------------- /docker/api-gateway.env.sample: -------------------------------------------------------------------------------- 1 | LOG_LEVEL="info" 2 | NODE_ENV=production 3 | VERSION=local 4 | 5 | NEW_RELIC_ENABLED=false 6 | NEW_RELIC_APP_NAME="API Gateway" 7 | NEW_RELIC_NO_CONFIG_FILE=true 8 | 9 | SYNCING_SERVER_JS_URL=http://syncing-server-js:3000 10 | AUTH_SERVER_URL=http://auth:3000 11 | 12 | REDIS_EVENTS_CHANNEL="api-gateway-events" 13 | 14 | WORKSPACE_SERVER_URL=http://workspace:3000 15 | 16 | REVISIONS_SERVER_URL=http://revisions:3000 17 | -------------------------------------------------------------------------------- /docker/auth.env.sample: -------------------------------------------------------------------------------- 1 | LOG_LEVEL="info" 2 | NODE_ENV="production" 3 | VERSION="local" 4 | 5 | AUTH_JWT_TTL=60000 6 | JWT_SECRET=secret 7 | LEGACY_JWT_SECRET=legacy_jwt_secret 8 | 9 | NEW_RELIC_ENABLED=false 10 | NEW_RELIC_APP_NAME=Auth 11 | NEW_RELIC_NO_CONFIG_FILE=true 12 | 13 | REDIS_EVENTS_CHANNEL="auth-events" 14 | 15 | DISABLE_USER_REGISTRATION=false 16 | 17 | PSEUDO_KEY_PARAMS_KEY=secret_key 18 | 19 | ACCESS_TOKEN_AGE=5184000 20 | REFRESH_TOKEN_AGE=31556926 21 | 22 | MAX_LOGIN_ATTEMPTS=6 23 | FAILED_LOGIN_LOCKOUT=3600 24 | 25 | EPHEMERAL_SESSION_AGE=259200 26 | 27 | # Must be a hex string exactly 32 bytes long 28 | # e.g. feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308 29 | ENCRYPTION_SERVER_KEY=server_key 30 | 31 | SYNCING_SERVER_URL=http://syncing-server-js:3000 32 | 33 | # File Uploads 34 | VALET_TOKEN_TTL=7200 35 | 36 | # Localstack Setup (Do not change unless you want to use your real AWS account) 37 | SNS_TOPIC_ARN="arn:aws:sns:us-east-1:000000000000:auth-local-topic" 38 | SNS_ENDPOINT="http://localstack:4566" 39 | SNS_DISABLE_SSL=true 40 | SNS_SECRET_ACCESS_KEY="x" 41 | SNS_ACCESS_KEY_ID="x" 42 | SNS_AWS_REGION="us-east-1" 43 | SQS_QUEUE_URL="http://localstack:4566/000000000000/auth-local-queue" 44 | SQS_AWS_REGION="us-east-1" 45 | SQS_ACCESS_KEY_ID="x" 46 | SQS_SECRET_ACCESS_KEY="x" 47 | SQS_ENDPOINT="http://localstack:4566" 48 | 49 | # (Optional) U2F Setup 50 | U2F_RELYING_PARTY_ID= 51 | U2F_RELYING_PARTY_NAME= 52 | U2F_EXPECTED_ORIGIN= 53 | U2F_REQUIRE_USER_VERIFICATION= 54 | -------------------------------------------------------------------------------- /docker/files.env.sample: -------------------------------------------------------------------------------- 1 | LOG_LEVEL="info" 2 | NODE_ENV=production 3 | VERSION=local 4 | 5 | PORT=3000 6 | 7 | S3_BUCKET_NAME= 8 | S3_AWS_REGION= 9 | SNS_TOPIC_ARN= 10 | SNS_AWS_REGION= 11 | 12 | REDIS_URL=redis://cache 13 | REDIS_EVENTS_CHANNEL=events 14 | 15 | MAX_CHUNK_BYTES=100000000 16 | 17 | NEW_RELIC_ENABLED=false 18 | 19 | # Localstack Setup (Do not change unless you want to use your real AWS account) 20 | SNS_TOPIC_ARN="arn:aws:sns:us-east-1:000000000000:files-local-topic" 21 | SNS_ENDPOINT="http://localstack:4566" 22 | SNS_DISABLE_SSL=true 23 | SNS_SECRET_ACCESS_KEY="x" 24 | SNS_ACCESS_KEY_ID="x" 25 | SNS_AWS_REGION="us-east-1" 26 | SQS_QUEUE_URL="http://localstack:4566/000000000000/files-local-queue" 27 | SQS_AWS_REGION="us-east-1" 28 | SQS_ACCESS_KEY_ID="x" 29 | SQS_SECRET_ACCESS_KEY="x" 30 | SQS_ENDPOINT="http://localstack:4566" 31 | -------------------------------------------------------------------------------- /docker/localstack_bootstrap.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -euo pipefail 4 | 5 | echo "configuring sns/sqs" 6 | echo "===================" 7 | LOCALSTACK_HOST=localhost 8 | AWS_REGION=us-east-1 9 | LOCALSTACK_DUMMY_ID=000000000000 10 | 11 | get_all_queues() { 12 | awslocal --endpoint-url=http://${LOCALSTACK_HOST}:4566 sqs list-queues 13 | } 14 | 15 | create_queue() { 16 | local QUEUE_NAME_TO_CREATE=$1 17 | awslocal --endpoint-url=http://${LOCALSTACK_HOST}:4566 sqs create-queue --queue-name ${QUEUE_NAME_TO_CREATE} 18 | } 19 | 20 | get_all_topics() { 21 | awslocal --endpoint-url=http://${LOCALSTACK_HOST}:4566 sns list-topics 22 | } 23 | 24 | create_topic() { 25 | local TOPIC_NAME_TO_CREATE=$1 26 | awslocal --endpoint-url=http://${LOCALSTACK_HOST}:4566 sns create-topic --name ${TOPIC_NAME_TO_CREATE} 27 | } 28 | 29 | link_queue_and_topic() { 30 | local TOPIC_ARN_TO_LINK=$1 31 | local QUEUE_ARN_TO_LINK=$2 32 | awslocal --endpoint-url=http://${LOCALSTACK_HOST}:4566 sns subscribe --topic-arn ${TOPIC_ARN_TO_LINK} --protocol sqs --notification-endpoint ${QUEUE_ARN_TO_LINK} 33 | } 34 | 35 | get_queue_arn_from_name() { 36 | local QUEUE_NAME=$1 37 | echo "arn:aws:sns:${AWS_REGION}:${LOCALSTACK_DUMMY_ID}:$QUEUE_NAME" 38 | } 39 | 40 | get_topic_arn_from_name() { 41 | local TOPIC_NAME=$1 42 | echo "arn:aws:sns:${AWS_REGION}:${LOCALSTACK_DUMMY_ID}:$TOPIC_NAME" 43 | } 44 | 45 | PAYMENTS_TOPIC_NAME="payments-local-topic" 46 | 47 | echo "creating topic $PAYMENTS_TOPIC_NAME" 48 | TOPIC_CREATED_RESULT=$(create_topic ${PAYMENTS_TOPIC_NAME}) 49 | echo "created topic: $TOPIC_CREATED_RESULT" 50 | PAYMENTS_TOPIC_ARN=$(get_topic_arn_from_name $PAYMENTS_TOPIC_NAME) 51 | 52 | SYNCING_SERVER_TOPIC_NAME="syncing-server-local-topic" 53 | 54 | echo "creating topic $SYNCING_SERVER_TOPIC_NAME" 55 | TOPIC_CREATED_RESULT=$(create_topic ${SYNCING_SERVER_TOPIC_NAME}) 56 | echo "created topic: $TOPIC_CREATED_RESULT" 57 | SYNCING_SERVER_TOPIC_ARN=$(get_topic_arn_from_name $SYNCING_SERVER_TOPIC_NAME) 58 | 59 | AUTH_TOPIC_NAME="auth-local-topic" 60 | 61 | echo "creating topic $AUTH_TOPIC_NAME" 62 | TOPIC_CREATED_RESULT=$(create_topic ${AUTH_TOPIC_NAME}) 63 | echo "created topic: $TOPIC_CREATED_RESULT" 64 | AUTH_TOPIC_ARN=$(get_topic_arn_from_name $AUTH_TOPIC_NAME) 65 | 66 | FILES_TOPIC_NAME="files-local-topic" 67 | 68 | echo "creating topic $FILES_TOPIC_NAME" 69 | TOPIC_CREATED_RESULT=$(create_topic ${FILES_TOPIC_NAME}) 70 | echo "created topic: $TOPIC_CREATED_RESULT" 71 | FILES_TOPIC_ARN=$(get_topic_arn_from_name $FILES_TOPIC_NAME) 72 | 73 | ANALYTICS_TOPIC_NAME="analytics-local-topic" 74 | 75 | echo "creating topic $ANALYTICS_TOPIC_NAME" 76 | TOPIC_CREATED_RESULT=$(create_topic ${ANALYTICS_TOPIC_NAME}) 77 | echo "created topic: $TOPIC_CREATED_RESULT" 78 | ANALYTICS_TOPIC_ARN=$(get_topic_arn_from_name $ANALYTICS_TOPIC_NAME) 79 | 80 | REVISIONS_TOPIC_NAME="revisions-server-local-topic" 81 | 82 | echo "creating topic $REVISIONS_TOPIC_NAME" 83 | TOPIC_CREATED_RESULT=$(create_topic ${REVISIONS_TOPIC_NAME}) 84 | echo "created topic: $TOPIC_CREATED_RESULT" 85 | REVISIONS_TOPIC_ARN=$(get_topic_arn_from_name $REVISIONS_TOPIC_NAME) 86 | 87 | SCHEDULER_TOPIC_NAME="scheduler-local-topic" 88 | 89 | echo "creating topic $SCHEDULER_TOPIC_NAME" 90 | TOPIC_CREATED_RESULT=$(create_topic ${SCHEDULER_TOPIC_NAME}) 91 | echo "created topic: $TOPIC_CREATED_RESULT" 92 | SCHEDULER_TOPIC_ARN=$(get_topic_arn_from_name $SCHEDULER_TOPIC_NAME) 93 | 94 | WORKSPACE_TOPIC_NAME="workspace-local-topic" 95 | 96 | echo "creating topic $WORKSPACE_TOPIC_NAME" 97 | TOPIC_CREATED_RESULT=$(create_topic ${WORKSPACE_TOPIC_NAME}) 98 | echo "created topic: $TOPIC_CREATED_RESULT" 99 | WORKSPACE_TOPIC_ARN=$(get_topic_arn_from_name $WORKSPACE_TOPIC_NAME) 100 | 101 | QUEUE_NAME="analytics-local-queue" 102 | 103 | echo "creating queue $QUEUE_NAME" 104 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 105 | echo "created queue: $QUEUE_URL" 106 | ANALYTICS_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 107 | 108 | echo "linking topic $PAYMENTS_TOPIC_ARN to queue $ANALYTICS_QUEUE_ARN" 109 | LINKING_RESULT=$(link_queue_and_topic $PAYMENTS_TOPIC_ARN $ANALYTICS_QUEUE_ARN) 110 | echo "linking done:" 111 | echo "$LINKING_RESULT" 112 | 113 | QUEUE_NAME="auth-local-queue" 114 | 115 | echo "creating queue $QUEUE_NAME" 116 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 117 | echo "created queue: $QUEUE_URL" 118 | AUTH_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 119 | 120 | echo "linking topic $PAYMENTS_TOPIC_ARN to queue $AUTH_QUEUE_ARN" 121 | LINKING_RESULT=$(link_queue_and_topic $PAYMENTS_TOPIC_ARN $AUTH_QUEUE_ARN) 122 | echo "linking done:" 123 | echo "$LINKING_RESULT" 124 | echo "linking topic $AUTH_TOPIC_ARN to queue $AUTH_QUEUE_ARN" 125 | LINKING_RESULT=$(link_queue_and_topic $AUTH_TOPIC_ARN $AUTH_QUEUE_ARN) 126 | echo "linking done:" 127 | echo "$LINKING_RESULT" 128 | echo "linking topic $FILES_TOPIC_ARN to queue $AUTH_QUEUE_ARN" 129 | LINKING_RESULT=$(link_queue_and_topic $FILES_TOPIC_ARN $AUTH_QUEUE_ARN) 130 | echo "linking done:" 131 | echo "$LINKING_RESULT" 132 | 133 | QUEUE_NAME="files-local-queue" 134 | 135 | echo "creating queue $QUEUE_NAME" 136 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 137 | echo "created queue: $QUEUE_URL" 138 | FILES_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 139 | 140 | echo "linking topic $AUTH_TOPIC_ARN to queue $FILES_QUEUE_ARN" 141 | LINKING_RESULT=$(link_queue_and_topic $AUTH_TOPIC_ARN $FILES_QUEUE_ARN) 142 | echo "linking done:" 143 | echo "$LINKING_RESULT" 144 | 145 | QUEUE_NAME="syncing-server-local-queue" 146 | 147 | echo "creating queue $QUEUE_NAME" 148 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 149 | echo "created queue: $QUEUE_URL" 150 | SYNCING_SERVER_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 151 | 152 | echo "linking topic $SYNCING_SERVER_TOPIC_ARN to queue $SYNCING_SERVER_QUEUE_ARN" 153 | LINKING_RESULT=$(link_queue_and_topic $SYNCING_SERVER_TOPIC_ARN $SYNCING_SERVER_QUEUE_ARN) 154 | echo "linking done:" 155 | echo "$LINKING_RESULT" 156 | 157 | echo "linking topic $SYNCING_SERVER_TOPIC_ARN to queue $SYNCING_SERVER_QUEUE_ARN" 158 | LINKING_RESULT=$(link_queue_and_topic $SYNCING_SERVER_TOPIC_ARN $SYNCING_SERVER_QUEUE_ARN) 159 | echo "linking done:" 160 | echo "$LINKING_RESULT" 161 | echo "linking topic $AUTH_TOPIC_ARN to queue $SYNCING_SERVER_QUEUE_ARN" 162 | LINKING_RESULT=$(link_queue_and_topic $AUTH_TOPIC_ARN $SYNCING_SERVER_QUEUE_ARN) 163 | echo "linking done:" 164 | echo "$LINKING_RESULT" 165 | 166 | QUEUE_NAME="revisions-server-local-queue" 167 | 168 | echo "creating queue $QUEUE_NAME" 169 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 170 | echo "created queue: $QUEUE_URL" 171 | REVISIONS_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 172 | 173 | echo "linking topic $SYNCING_SERVER_TOPIC_ARN to queue $REVISIONS_QUEUE_ARN" 174 | LINKING_RESULT=$(link_queue_and_topic $SYNCING_SERVER_TOPIC_ARN $REVISIONS_QUEUE_ARN) 175 | echo "linking done:" 176 | echo "$LINKING_RESULT" 177 | 178 | QUEUE_NAME="scheduler-local-queue" 179 | 180 | echo "creating queue $QUEUE_NAME" 181 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 182 | echo "created queue: $QUEUE_URL" 183 | SCHEDULER_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 184 | 185 | QUEUE_NAME="workspace-local-queue" 186 | 187 | echo "creating queue $QUEUE_NAME" 188 | QUEUE_URL=$(create_queue ${QUEUE_NAME}) 189 | echo "created queue: $QUEUE_URL" 190 | WORKSPACE_QUEUE_ARN=$(get_queue_arn_from_name $QUEUE_NAME) 191 | 192 | echo "all topics are:" 193 | echo "$(get_all_topics)" 194 | 195 | echo "all queues are:" 196 | echo "$(get_all_queues)" 197 | -------------------------------------------------------------------------------- /docker/revisions.env.sample: -------------------------------------------------------------------------------- 1 | LOG_LEVEL="info" 2 | NODE_ENV=production 3 | VERSION=local 4 | 5 | REDIS_URL="redis://cache:6379" 6 | 7 | REDIS_EVENTS_CHANNEL="revisions-events" 8 | 9 | NEW_RELIC_ENABLED=false 10 | 11 | # Localstack Setup (Do not change unless you want to use your real AWS account) 12 | SNS_TOPIC_ARN="arn:aws:sns:us-east-1:000000000000:revisions-server-local-topic" 13 | SNS_ENDPOINT="http://localstack:4566" 14 | SNS_DISABLE_SSL=true 15 | SNS_SECRET_ACCESS_KEY="x" 16 | SNS_ACCESS_KEY_ID="x" 17 | SNS_AWS_REGION="us-east-1" 18 | SQS_QUEUE_URL="http://localstack:4566/000000000000/revisions-server-local-queue" 19 | SQS_AWS_REGION="us-east-1" 20 | SQS_ACCESS_KEY_ID="x" 21 | SQS_SECRET_ACCESS_KEY="x" 22 | SQS_ENDPOINT="http://localstack:4566" 23 | -------------------------------------------------------------------------------- /server.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | DOCKER_VERSION=`docker --version` 4 | 5 | if [ "$?" -ne "0" ]; then 6 | echo "Please install Docker before proceeding." 7 | exit 1 8 | fi 9 | 10 | CURL_AVAILABLE=`which curl` 11 | 12 | if [ "$?" -ne "0" ]; then 13 | echo "Please install cURL before proceeding." 14 | exit 1 15 | fi 16 | 17 | DOCKER_COMPOSE_COMMAND="docker compose" 18 | if ! $DOCKER_COMPOSE_COMMAND > /dev/null 2>&1; then 19 | DOCKER_COMPOSE_COMMAND="docker-compose" 20 | fi 21 | 22 | checkConfigFiles() { 23 | if [ ! -f ".env" ]; then echo "Could not find syncing-server environment file. Please run the './server.sh setup' command and try again." && exit 1; fi 24 | if [ ! -f "docker/api-gateway.env" ]; then echo "Could not find api-gateway environment file. Please run the './server.sh setup' command and try again." && exit 1; fi 25 | if [ ! -f "docker/auth.env" ]; then echo "Could not find auth environment file. Please run the './server.sh setup' command and try again." && exit 1; fi 26 | if [ ! -f "docker/files.env" ]; then echo "Could not find file service environment file. Please run the './server.sh setup' command and try again." && exit 1; fi 27 | if [ ! -f "docker/revisions.env" ]; then echo "Could not find revisions service environment file. Please run the './server.sh setup' command and try again." && exit 1; fi 28 | } 29 | 30 | checkForConfigFileChanges() { 31 | checkConfigFiles 32 | compareLineCount 33 | } 34 | 35 | compareLineCount() { 36 | MAIN_ENV_FILE_SAMPLE_LINES=$(wc -l .env.sample | awk '{ print $1 }') 37 | MAIN_ENV_FILE_LINES=$(wc -l .env | awk '{ print $1 }') 38 | if [ "$MAIN_ENV_FILE_SAMPLE_LINES" -ne "$MAIN_ENV_FILE_LINES" ]; then echo "The .env file contains different amount of lines than .env.sample. This may be caused by the fact that there is a new environment variable to configure. Please update your environment file and try again." && exit 1; fi 39 | 40 | API_GATEWAY_ENV_FILE_SAMPLE_LINES=$(wc -l docker/api-gateway.env.sample | awk '{ print $1 }') 41 | API_GATEWAY_ENV_FILE_LINES=$(wc -l docker/api-gateway.env | awk '{ print $1 }') 42 | if [ "$API_GATEWAY_ENV_FILE_SAMPLE_LINES" -ne "$API_GATEWAY_ENV_FILE_LINES" ]; then echo "The docker/api-gateway.env file contains different amount of lines than docker/api-gateway.env.sample. This may be caused by the fact that there is a new environment variable to configure. Please update your environment file and try again." && exit 1; fi 43 | 44 | AUTH_ENV_FILE_SAMPLE_LINES=$(wc -l docker/auth.env.sample | awk '{ print $1 }') 45 | AUTH_ENV_FILE_LINES=$(wc -l docker/auth.env | awk '{ print $1 }') 46 | if [ "$AUTH_ENV_FILE_SAMPLE_LINES" -ne "$AUTH_ENV_FILE_LINES" ]; then echo "The docker/auth.env file contains different amount of lines than docker/auth.env.sample. This may be caused by the fact that there is a new environment variable to configure. Please update your environment file and try again." && exit 1; fi 47 | 48 | FILES_ENV_FILE_SAMPLE_LINES=$(wc -l docker/files.env.sample | awk '{ print $1 }') 49 | FILES_ENV_FILE_LINES=$(wc -l docker/files.env | awk '{ print $1 }') 50 | if [ "$FILES_ENV_FILE_SAMPLE_LINES" -ne "$FILES_ENV_FILE_LINES" ]; then echo "The docker/files.env file contains different amount of lines than docker/files.env.sample. This may be caused by the fact that there is a new environment variable to configure. Please update your environment file and try again." && exit 1; fi 51 | 52 | REVISIONS_ENV_FILE_SAMPLE_LINES=$(wc -l docker/revisions.env.sample | awk '{ print $1 }') 53 | REVISIONS_ENV_FILE_LINES=$(wc -l docker/revisions.env | awk '{ print $1 }') 54 | if [ "$REVISIONS_ENV_FILE_SAMPLE_LINES" -ne "$REVISIONS_ENV_FILE_LINES" ]; then echo "The docker/revisions.env file contains different amount of lines than docker/files.env.sample. This may be caused by the fact that there is a new environment variable to configure. Please update your environment file and try again." && exit 1; fi 55 | } 56 | 57 | cleanup() { 58 | local output_logs=$1 59 | if [ $output_logs == 1 ] 60 | then 61 | echo "Outputing last 100 lines of logs" 62 | $DOCKER_COMPOSE_COMMAND logs --tail=100 63 | fi 64 | } 65 | 66 | waitForServices() { 67 | attempt=0 68 | while [ $attempt -le 180 ]; do 69 | attempt=$(( $attempt + 1 )) 70 | echo "# Waiting for all services to be up (attempt: $attempt) ..." 71 | ping_api_gateway_result=`curl -s $($DOCKER_COMPOSE_COMMAND port api-gateway 3000)` 72 | if [ "$?" -eq "0" ]; then 73 | sleep 2 # for warmup 74 | echo "# All services are up!" 75 | break 76 | fi 77 | sleep 2 78 | done 79 | } 80 | 81 | replaceConfigValue() { 82 | local config_file=$1 83 | local config_key=$2 84 | local config_value=$3 85 | 86 | if [[ $OSTYPE == 'darwin'* ]]; then 87 | sed -i '' "s/$config_key=.*/$config_key=$config_value/g" $config_file 88 | else 89 | sed -i "s/$config_key=.*/$config_key=$config_value/g" $config_file 90 | fi 91 | } 92 | 93 | COMMAND=$1 && shift 1 94 | 95 | case "$COMMAND" in 96 | 'setup' ) 97 | echo "Initializing default configuration" 98 | if [ ! -f ".env" ]; then cp .env.sample .env; fi 99 | if [ ! -f "docker/api-gateway.env" ]; then cp docker/api-gateway.env.sample docker/api-gateway.env; fi 100 | if [ ! -f "docker/auth.env" ]; then cp docker/auth.env.sample docker/auth.env; fi 101 | if [ ! -f "docker/files.env" ]; then cp docker/files.env.sample docker/files.env; fi 102 | if [ ! -f "docker/revisions.env" ]; then cp docker/revisions.env.sample docker/revisions.env; fi 103 | echo "Default configuration files created as .env and docker/*.env files. Feel free to modify values if needed." 104 | ;; 105 | 'restore-config-defaults' ) 106 | echo "Initializing default configuration" 107 | cp .env.sample .env 108 | cp docker/api-gateway.env.sample docker/api-gateway.env 109 | cp docker/auth.env.sample docker/auth.env 110 | cp docker/files.env.sample docker/files.env 111 | cp docker/revisions.env.sample docker/revisions.env 112 | echo "Default configuration files restored as .env and docker/*.env files. Feel free to modify values if needed." 113 | ;; 114 | 'start' ) 115 | checkForConfigFileChanges 116 | echo "Starting up infrastructure" 117 | $DOCKER_COMPOSE_COMMAND up -d 118 | echo "Infrastructure started. Give it a moment to warm up. If you wish please run the './server.sh logs' command to see details." 119 | ;; 120 | 'status' ) 121 | echo "Services State:" 122 | $DOCKER_COMPOSE_COMMAND ps 123 | ;; 124 | 'logs' ) 125 | $DOCKER_COMPOSE_COMMAND logs -f 126 | ;; 127 | 'update' ) 128 | echo "Stopping all services." 129 | $DOCKER_COMPOSE_COMMAND kill --remove-orphans || true 130 | echo "Pulling changes from Git." 131 | git pull origin $(git rev-parse --abbrev-ref HEAD) 132 | echo "Checking for env file changes" 133 | checkForConfigFileChanges 134 | echo "Downloading latest images of Standard Notes services." 135 | $DOCKER_COMPOSE_COMMAND pull 136 | echo "Images up to date. Starting all services." 137 | $DOCKER_COMPOSE_COMMAND up -d 138 | echo "Infrastructure started. Give it a moment to warm up. If you wish please run the './server.sh logs' command to see details." 139 | ;; 140 | 'create-subscription' ) 141 | EMAIL=$1 142 | if [[ "$EMAIL" = "" ]]; then 143 | echo "Please provide an email for the subscription." 144 | exit 1 145 | fi 146 | shift 1 147 | 148 | $DOCKER_COMPOSE_COMMAND exec db sh -c "MYSQL_PWD=\$MYSQL_ROOT_PASSWORD mysql \$MYSQL_DATABASE -e \ 149 | 'INSERT INTO user_roles (role_uuid , user_uuid) VALUES ((SELECT uuid FROM roles WHERE name=\"PRO_USER\" ORDER BY version DESC limit 1) ,(SELECT uuid FROM users WHERE email=\"$EMAIL\")) ON DUPLICATE KEY UPDATE role_uuid = VALUES(role_uuid);' \ 150 | " 151 | 152 | $DOCKER_COMPOSE_COMMAND exec db sh -c "MYSQL_PWD=\$MYSQL_ROOT_PASSWORD mysql \$MYSQL_DATABASE -e \ 153 | 'INSERT INTO user_subscriptions SET uuid=UUID(), plan_name=\"PRO_PLAN\", ends_at=8640000000000000, created_at=0, updated_at=0, user_uuid=(SELECT uuid FROM users WHERE email=\"$EMAIL\"), subscription_id=1, subscription_type=\"regular\";' \ 154 | " 155 | 156 | echo "Subscription successfully created. Please consider donating if you do not plan on purchasing a subscription." 157 | ;; 158 | 'dump-db' ) 159 | echo "Dumping database to data/mysql/001-db-dump.sql" 160 | $DOCKER_COMPOSE_COMMAND exec db sh -c "MYSQL_PWD=\$MYSQL_ROOT_PASSWORD mysqldump -cn -u root \$MYSQL_DATABASE > /var/lib/mysql/001-db-dump.sql" 161 | echo "Database dump complete" 162 | echo "Creating sql adjustments file to data/revisions-db/002-adjust.sql" 163 | echo "ALTER TABLE \`revisions\` ADD COLUMN \`user_uuid\` varchar(36) NULL" > data/revisions-db/002-adjust.sql 164 | echo "Creating sql adjustments file complete" 165 | echo "Dumping revisions database to data/revisions-db/003-revisions-dump.sql" 166 | $DOCKER_COMPOSE_COMMAND exec revisions-db sh -c "MYSQL_PWD=\$MYSQL_ROOT_PASSWORD mysqldump -ctn -u root --ignore-table=\$MYSQL_DATABASE.migrations \$MYSQL_DATABASE > /var/lib/mysql/003-revisions-dump.sql" 167 | echo "Revisions Database dump complete" 168 | echo "Creating sql revisions ownership file to data/revisions-db/004-revisions-ownership.sql" 169 | echo "UPDATE revisions r SET r.user_uuid=(SELECT i.user_uuid FROM items i WHERE i.uuid = r.item_uuid LIMIT 1)" > data/revisions-db/004-revisions-ownership.sql 170 | echo "Creating sql revisions ownership file complete" 171 | ;; 172 | 'stop' ) 173 | echo "Stopping all service" 174 | $DOCKER_COMPOSE_COMMAND kill --remove-orphans 175 | echo "Services stopped" 176 | ;; 177 | 'version' ) 178 | $DOCKER_COMPOSE_COMMAND images 179 | ;; 180 | 'cleanup' ) 181 | echo "WARNING: This will permanently delete all of your data! Are you sure?" 182 | read -p "Continue (y/n)?" choice 183 | case "$choice" in 184 | y|Y ) 185 | $DOCKER_COMPOSE_COMMAND kill --remove-orphans && $DOCKER_COMPOSE_COMMAND rm -fv 186 | rm -rf data/mysql 187 | rm -rf data/revisions-db 188 | rm -rf data/redis 189 | echo "Cleanup performed. You can start your server with a clean environment." 190 | ;; 191 | n|N ) 192 | echo "Cleanup aborted" 193 | exit 0 194 | ;; 195 | * ) 196 | echo "Invalid option supplied. Aborted cleanup." 197 | ;; 198 | esac 199 | ;; 200 | 'generate-keys' ) 201 | replaceConfigValue .env AUTH_JWT_SECRET $(openssl rand -hex 32) 202 | replaceConfigValue .env VALET_TOKEN_SECRET $(openssl rand -hex 32) 203 | replaceConfigValue .env DB_PASSWORD $(openssl rand -hex 32) 204 | replaceConfigValue .env REVISIONS_DB_PASSWORD $(openssl rand -hex 32) 205 | replaceConfigValue docker/auth.env LEGACY_JWT_SECRET $(openssl rand -hex 32) 206 | replaceConfigValue docker/auth.env PSEUDO_KEY_PARAMS_KEY $(openssl rand -hex 32) 207 | replaceConfigValue docker/auth.env ENCRYPTION_SERVER_KEY $(openssl rand -hex 32) 208 | replaceConfigValue docker/auth.env JWT_SECRET $(openssl rand -hex 32) 209 | ;; 210 | 'wait-for-startup' ) 211 | waitForServices 212 | ;; 213 | 'test' ) 214 | waitForServices 215 | 216 | echo "# Starting test suite ..." 217 | npx mocha-headless-chrome --timeout 1200000 -f http://localhost:9001/mocha/test.html 218 | test_result=$? 219 | 220 | cleanup $test_result 221 | 222 | if [[ $test_result == 0 ]] 223 | then 224 | exit 0 225 | else 226 | exit 1 227 | fi 228 | ;; 229 | * ) 230 | echo "Unknown command" 231 | ;; 232 | esac 233 | 234 | exec "$@" 235 | --------------------------------------------------------------------------------