Skip to content

Commit f9a24ab

Browse files
author
Rajat
committed
Removed vercel from self hosting
1 parent 608ba0a commit f9a24ab

1 file changed

Lines changed: 17 additions & 34 deletions

File tree

apps/docs-new/content/docs/self-hosting/self-host.mdx

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,17 @@ title: CourseLit Self Hosting Guide
33
description: CourseLit Self Hosting Guide
44
---
55

6-
> **Before you self-host**: Although we believe in the power of hosting your own software, we still think that buying a subscription to [CourseLit](https://courselit.app) will save you a lot of time and money of maintaining your own CourseLit instance. Check out our [pricing](https://courselit.app/#pricing).
6+
> Before you self-host: Although we believe in the power of hosting your own software, we still think that buying a subscription to [CourseLit](https://courselit.app) will save you a lot of time and money compared with maintaining your own CourseLit instance. Check out our [pricing](https://courselit.app/#pricing).
77
8-
We offer two ways to self-host CourseLit, which are as follows.
9-
10-
1. On [Vercel](https://vercel.com).
11-
2. On a VPS using Docker.
12-
13-
## Hosting on Vercel
14-
15-
To quickly spin up an instance of CourseLit on Vercel, click the following button.
16-
17-
<a
18-
href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fcodelitdev%2Fcourselit&env=DB_CONNECTION_STRING,AUTH_SECRET,SUPER_ADMIN_EMAIL,EMAIL_USER,EMAIL_PASS,EMAIL_HOST,EMAIL_FROM&envDescription=Configuration%20for%20your%20app&project-name=courselit&root-directory=apps%2Fweb&build-command=cd+..%2F+%26%26+NODE_OPTIONS%3D--openssl-legacy-provider+yarn+build"
19-
rel="noreferrer"
20-
target="_blank"
21-
>
22-
<img src="https://vercel.com/button" alt="Deploy with Vercel" />
23-
</a>
24-
25-
> Note: Certain essential features like file uploads, email automation and drip content will not work as these cannot run on a serverless platform like Vercel. However, you can make file uploads work by using the hosted instance of [MediaLit](https://medialit.cloud) (our open-source service for file uploads, which CourseLit uses under the hood) for free.
8+
We distribute Docker images for all our services through Docker Hub.
269

2710
## Hosting on a VPS using Docker
2811

29-
If you want to harness the full capabilities of CourseLit, you can deploy it via Docker. We recommend [docker-compose](https://docs.docker.com/compose/) for hosting CourseLit.
12+
We recommend [Docker Compose](https://docs.docker.com/compose/) for hosting CourseLit.
3013

3114
Run the following commands in order.
3215

33-
##### 1. Download `docker-compose.yml` file onto your system.
16+
##### 1. Download the `docker-compose.yml` file to your system.
3417

3518
```sh
3619
curl https://raw.githubusercontent.com/codelitdev/courselit/main/deployment/docker/docker-compose.yml --output docker-compose.yml --silent
@@ -44,29 +27,29 @@ SUPER_ADMIN_EMAIL=your@email.com docker compose up
4427

4528
The email you specify here will be set as the super admin of your CourseLit instance.
4629

47-
> **Troubleshooting**: If you are going to run this command multiple times, be aware that the super admin user will only be created once and with the email ID you provided the very first time. Hence, if you are not able to access the `/dashboard` route, it is most likely that the email you are using is not associated with the super admin account. Try removing the Docker containers by running `SUPER_ADMIN_EMAIL=your@email.com docker compose down` and start again.
30+
> **Troubleshooting**: If you run this command multiple times, note that the super admin user will be created only once, using the email address you provided the first time. If you are unable to access the `/dashboard` route, it is most likely because the email you are using is not associated with the super admin account. Try removing the Docker containers by running `SUPER_ADMIN_EMAIL=your@email.com docker compose down`, then start again.
4831
4932
##### 3. Test drive your CourseLit school
5033

51-
Visit [http://localhost](http://localhost) to see your school. There won't be much to see at this point. You need to customise it.
34+
Visit [http://localhost](http://localhost) to see your school. There will not be much to see at this point, because you still need to customize it.
5235

5336
##### 4. Log in to your school
5437

55-
Click on the top right icon and then on the [login](http://localhost/login) menu. Enter the email you provided in Step #2 to log in. Since, we haven't set the mail yet, the magic link to log in will be dumped onto the `docker compose` logs. Locate the link and click on it (or copy paste it in the browser) to log in.
38+
Click the top-right icon, then click the [login](http://localhost/login) menu item. Enter the email you provided in Step 2 to log in. Since mail is not configured yet, the magic login link will be printed in the `docker compose` logs. Locate the link and click it, or copy and paste it into your browser to log in.
5639

5740
The login link looks something like `http://localhost/login?token=some-long-string`.
5841

5942
##### 5. Customise your school
6043

61-
Visit [http://localhost/dashboard](http://localhost/dashboard) to customise your school.
44+
Visit [http://localhost/dashboard](http://localhost/dashboard) to customize your school.
6245

63-
> Note: This will be a barebones instance. Things like mails and file uploads will not work. You can follow rest of this guide to set those things up.
46+
> Note: This will be a bare-bones instance. Features such as email and file uploads will not work yet. You can follow the rest of this guide to set those up.
6447
6548
### Enabling emails
6649

67-
If you want to send emails (including Magic links to log in) using CourseLit, it is easy as well.
50+
If you want to send emails, including magic login links, with CourseLit, that is easy to set up as well.
6851

69-
1. Create an enviroment file called `.env` with the following content (in the same directory as your `docker-compose.yml` file) and replace the values accordingly.
52+
1. Create an environment file called `.env` with the following content in the same directory as your `docker-compose.yml` file, and replace the values as needed.
7053

7154
```
7255
SUPER_ADMIN_EMAIL=your@email.com
@@ -87,11 +70,11 @@ docker compose up
8770

8871
### Enabling file uploads
8972

90-
If you want to upload media (images, videos etc.) to your school, you need to configure [MediaLit](https://hub.docker.com/r/codelit/medialit). MediaLit powers CourseLit's media management and optimisation. MediaLit offers a Docker image which you can self host.
73+
If you want to upload media such as images and videos to your school, you need to configure [MediaLit](https://hub.docker.com/r/codelit/medialit). MediaLit powers CourseLit's media management and optimization. MediaLit provides a Docker image that you can self-host.
9174

92-
To self host, follow the following steps.
75+
To self-host it, follow these steps.
9376

94-
1. Uncomment the block under the `app` service in `docker-compose.yml` which says the following.
77+
1. Uncomment the block under the `app` service in `docker-compose.yml` that looks like this:
9578

9679
```
9780
# - MEDIALIT_APIKEY=${MEDIALIT_APIKEY}
@@ -100,7 +83,7 @@ To self host, follow the following steps.
10083

10184
2. Uncomment the block titled `MediaLit` in `docker-compose.yml`.
10285

103-
3. In your `.env` file, paste the following code (under the existing content) and change the values as per your environment.
86+
3. In your `.env` file, paste the following code under the existing content and change the values to match your environment.
10487

10588
```
10689
# Medialit Server
@@ -132,15 +115,15 @@ To self host, follow the following steps.
132115

133116
Copy the API key.
134117

135-
5. Update the `MEDIALIT_APIKEY` value in `.env` file and restart the service once again.
118+
5. Update the `MEDIALIT_APIKEY` value in your `.env` file and restart the service.
136119

137120
6. That's it! You now have a fully functioning LMS powered by CourseLit and MediaLit.
138121

139122
## Hosted version
140123

141124
If this is too technical for you to handle, CourseLit's hosted version is available at [CourseLit.app](https://courselit.app).
142125

143-
It is managed by the team behind CourseLit. We will take care of everything, just come with your team and content.
126+
It is managed by the team behind CourseLit. We take care of everything, so you can focus on your team and content.
144127

145128
## Stuck somewhere?
146129

0 commit comments

Comments
 (0)