GITBOOK-6: No subject

This commit is contained in:
Amruth Pillai
2025-01-17 22:31:07 +00:00
committed by gitbook-bot
parent 111462df5a
commit a17203ba5d
3 changed files with 272 additions and 7 deletions

View File

@ -23,21 +23,22 @@
## Product Guides
* [🦸 Setting up your account](product-guides/setting-up-your-account.md)
* [🖊 Updating your profile](product-guides/updating-your-profile.md)
* [🖊 Updating your profile](product-guides/updating-your-profile.md)
* [🔑 Updating your password](product-guides/updating-your-password.md)
* [🛂 Setting up two-factor authentication](product-guides/setting-up-two-factor-authentication.md)
* [🧠 Enabling OpenAI Integration](product-guides/enabling-openai-integration.md)
* [🇦🇮 Translate your resume with ChatGPT](product-guides/translate-your-resume-with-chatgpt.md)
* [👩💻 Exporting your resume as JSON](product-guides/exporting-your-resume-as-json.md)
* [👩💻 Exporting your resume as PDF](product-guides/exporting-your-resume-as-pdf.md)
* [👩💻 Exporting your resume as JSON](product-guides/exporting-your-resume-as-json.md)
* [👩💻 Exporting your resume as PDF](product-guides/exporting-your-resume-as-pdf.md)
* [📢 Making your resume publicly available](product-guides/making-your-resume-publicly-available.md)
* [🖇 Importing your data from LinkedIn](product-guides/importing-your-data-from-linkedin.md)
* [🖇 Importing your data from LinkedIn](product-guides/importing-your-data-from-linkedin.md)
* [📃 Creating a Multi-Page Resume](product-guides/creating-a-multi-page-resume.md)
* [🧠 Use ChatGPT to rewrite your resume](product-guides/use-chatgpt-to-rewrite-your-resume.md)
* [🔄 Change the number of columns for a section](product-guides/change-the-number-of-columns-for-a-section.md)
* [🖥️ Self-Hosting Reactive Resume using Docker](product-guides/self-hosting-reactive-resume-using-docker.md)
## Meta
* [⚖ License](meta/license.md)
* [ License](meta/license.md)
* [🔏 Privacy Policy](meta/privacy-policy.md)
* [🐕🦺 Terms of Service](meta/terms-of-service.md)
* [🐕🦺 Terms of Service](meta/terms-of-service.md)

View File

@ -6,7 +6,6 @@ Here's a brief overview of the tech stack that's used to build Reactive Resume.
* [NestJS](https://nestjs.com/), as the backend
* [PostgreSQL](https://www.postgresql.org/), as the primary database
* [Prisma ORM](https://www.prisma.io/), as the interface between the server and the database
* [Redis](https://redis.io/), mostly for caching, but also used to track resume statistics
* [Minio](https://min.io/), an open-source S3 alternative to store objects
* [Browserless](https://www.browserless.io/), an open-source docker image that allows to run headless Chrome as a separate service

View File

@ -0,0 +1,265 @@
---
description: >-
This should be an in-depth guide on how to set up Reactive Resume on your
Virtual Private Server running a run-off-the-mill Linux distribution.
---
# 🖥️ Self-Hosting Reactive Resume using Docker
I'll be setting the application today using a Hetzner Cloud server, but you could use any VPS. A good place to find a decent server can be [https://lowendbox.com/](https://lowendbox.com/). They are a great resource to find deals and dirt cheap offers on VPSes, especially active during Black Friday.
The server I am going to set up Reactive Resume is a simple one, with these specifications:
```
CPU: Intel (2vCPU)
RAM: 4 GB
SSD: 40 GB
OS: Debian 12
Price: 3.92 EUR per month
```
I'm going to assume you have already set up your server along with a user account (with sudo access) and that you have Docker and Docker Compose setup on your machine. If you haven't, these links should help you much better than I can:
* [https://www.digitalocean.com/community/tutorials/initial-server-setup-with-debian-11](https://www.digitalocean.com/community/tutorials/initial-server-setup-with-debian-11)
* [https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-debian-10](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-debian-10)
Copy the following code to the home folder (or any specific project folder) on your machine, to a file named `compose.yml`or `docker-compose.yml`. If you choose to name the file anything else, you would need to run the docker compose command along with the `-f [file path]` flag.
{% code lineNumbers="true" fullWidth="true" %}
```yaml
# In this Docker Compose example, it assumes that you maintain a reverse proxy externally (or chose not to).
# The only two exposed ports here are from minio (:9000) and the app itself (:3000).
# If these ports are changed, ensure that the env vars passed to the app are also changed accordingly.
services:
# Database (Postgres)
postgres:
image: postgres:16-alpine
restart: unless-stopped
volumes:
- postgres_data:/var/lib/postgresql/data
environment:
POSTGRES_DB: postgres
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
healthcheck:
test: ["CMD-SHELL", "pg_isready -U postgres -d postgres"]
interval: 10s
timeout: 5s
retries: 5
# Storage (for image uploads)
minio:
image: minio/minio:latest
restart: unless-stopped
command: server /data
ports:
- "9000:9000"
volumes:
- minio_data:/data
environment:
MINIO_ROOT_USER: minioadmin
MINIO_ROOT_PASSWORD: minioadmin
# Chrome Browser (for printing and previews)
chrome:
image: ghcr.io/browserless/chromium:v2.18.0 # Upgrading to newer versions causes issues
restart: unless-stopped
extra_hosts:
- "host.docker.internal:host-gateway"
environment:
TIMEOUT: 10000
CONCURRENT: 10
TOKEN: chrome_token
EXIT_ON_HEALTH_FAILURE: "true"
PRE_REQUEST_HEALTH_CHECK: "true"
app:
image: amruthpillai/reactive-resume:latest
restart: unless-stopped
ports:
- "3000:3000"
depends_on:
- postgres
- minio
- chrome
environment:
# -- Environment Variables --
PORT: 3000
NODE_ENV: production
# -- URLs --
PUBLIC_URL: http://[your-server-ip]:3000
STORAGE_URL: http://[your-server-ip]:9000/default
# -- Printer (Chrome) --
CHROME_TOKEN: chrome_token
CHROME_URL: ws://chrome:3000
# -- Database (Postgres) --
DATABASE_URL: postgresql://postgres:postgres@postgres:5432/postgres
# -- Auth --
ACCESS_TOKEN_SECRET: access_token_secret
REFRESH_TOKEN_SECRET: refresh_token_secret
# -- Emails --
MAIL_FROM: noreply@localhost
# SMTP_URL: smtp://user:pass@smtp:587 # Optional
# -- Storage (Minio) --
STORAGE_ENDPOINT: minio
STORAGE_PORT: 9000
STORAGE_REGION: us-east-1 # Optional
STORAGE_BUCKET: default
STORAGE_ACCESS_KEY: minioadmin
STORAGE_SECRET_KEY: minioadmin
STORAGE_USE_SSL: "false"
STORAGE_SKIP_BUCKET_CHECK: "false"
# -- Crowdin (Optional) --
# CROWDIN_PROJECT_ID:
# CROWDIN_PERSONAL_TOKEN:
# -- Email (Optional) --
# DISABLE_SIGNUPS: "false"
# DISABLE_EMAIL_AUTH: "false"
# -- GitHub (Optional) --
# GITHUB_CLIENT_ID: github_client_id
# GITHUB_CLIENT_SECRET: github_client_secret
# GITHUB_CALLBACK_URL: http://localhost:3000/api/auth/github/callback
# -- Google (Optional) --
# GOOGLE_CLIENT_ID: google_client_id
# GOOGLE_CLIENT_SECRET: google_client_secret
# GOOGLE_CALLBACK_URL: http://localhost:3000/api/auth/google/callback
# -- OpenID (Optional) --
# VITE_OPENID_NAME: OpenID
# OPENID_AUTHORIZATION_URL:
# OPENID_CALLBACK_URL: http://localhost:3000/api/auth/openid/callback
# OPENID_CLIENT_ID:
# OPENID_CLIENT_SECRET:
# OPENID_ISSUER:
# OPENID_SCOPE: openid profile email
# OPENID_TOKEN_URL:
# OPENID_USER_INFO_URL:
volumes:
minio_data:
postgres_data:
```
{% endcode %}
{% hint style="info" %}
Make sure to update all the environment variables.
In this case, there's nothing much to change except on line 63 and 64 where you need to replace the \[your-server-ip] with your actual public Server IP address and to make use of secure passwords for Postgres and Minio.
{% endhint %}
Now, run the compose project by running the following command:
```
docker compose up -d
```
This should take about a few minutes depending on your server's network connection.
Once it is finished, run the logs command to check the logs to see if everything is running correctly:
```
docker compose logs -f
```
If you see the following output, it means everything is working as expected:
<pre data-line-numbers data-full-width="true"><code>app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [NestFactory] Starting Nest application...
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] AppModule dependencies initialized +44ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ConfigModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] MailerModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] RavenModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] PassportModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] AuthModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] HttpModule dependencies initialized +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] JwtModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ConfigHostModule dependencies initialized +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] DatabaseModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] TerminusModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ServeStaticModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ServeStaticModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ConfigModule dependencies initialized +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM WARN [MailModule] Since `SMTP_URL` is not set, emails would be logged to the console instead. This is not recommended for production environments.
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] PrismaModule dependencies initialized +16ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] MailerCoreModule dependencies initialized +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] MinioModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] FeatureModule dependencies initialized +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] TranslationModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ContributorsModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] MailModule dependencies initialized +2ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] PrinterModule dependencies initialized +3ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] StorageModule dependencies initialized +8ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] HealthModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] UserModule dependencies initialized +2ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] ResumeModule dependencies initialized +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:53 PM LOG [InstanceLoader] AuthModule dependencies initialized +1ms
app-1 | Warning: connect.session() MemoryStore is not
app-1 | designed for a production environment, as it will leak
app-1 | memory, and will not scale past a single process.
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] HealthController {/api/health}: +49ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/health, GET} route +4ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/health/environment, GET} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] StorageController {/api/storage}: +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/storage/image, PUT} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] AuthController {/api/auth}: +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/register, POST} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/login, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/providers, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/github, GET} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/github/callback, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/google, GET} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/google/callback, GET} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/openid, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/openid/callback, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/refresh, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/password, PATCH} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/logout, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/2fa/setup, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/2fa/enable, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/2fa/disable, POST} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/2fa/verify, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/2fa/backup, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/forgot-password, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/reset-password, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/verify-email, POST} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/auth/verify-email/resend, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] UserController {/api/user}: +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/user/me, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/user/me, PATCH} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/user/me, DELETE} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] ResumeController {/api/resume}: +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/schema, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/import, POST} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume, GET} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/:id, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/:id/statistics, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/public/:username/:slug, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/:id, PATCH} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/:id/lock, PATCH} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/:id, DELETE} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/print/:id, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/resume/print/:id/preview, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] FeatureController {/api/feature}: +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/feature/flags, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] TranslationController {/api/translation}: +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/translation/languages, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RoutesResolver] ContributorsController {/api/contributors}: +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/contributors/github, GET} route +1ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [RouterExplorer] Mapped {/api/contributors/crowdin, GET} route +0ms
app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [StorageService] A new storage bucket has been created and the policy has been applied successfully.
<strong>app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [NestApplication] Nest application successfully started +15ms
</strong>app-1 | [Nest] 75 - 01/17/2025, 10:22:54 PM LOG [Bootstrap] 🚀 Server is up and running on port 3000
</code></pre>
Now, just head over to `http://[your-server-ip]:3000` and you should see Reactive Resume working as expected. You can now create a new account, create a resume and print as PDF immediately.