Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish new DoltLab Getting Started and other chnages #2246

Merged
merged 8 commits into from
May 31, 2024
12 changes: 7 additions & 5 deletions packages/dolt/content/guides/dolt-tested-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,30 @@ Let us know what else you'd like to see tested by sending us [email](mailto:inte
## Frameworks/ORMs
| ORM | Language | Blog | Sample Code |
|-------------------------------------------------------------------------------------------|------------|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|
| [SQLAlchemy](https://www.sqlalchemy.org/) | Python | [Blog](https://www.dolthub.com/blog/2023-07-12-sql-alchemy-getting-started/) | [Code](https://github.com/timsehn/dolt-sqlalchemy-getting-started/tree/main) |
| [ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/introduction-to-aspnet-core) | C# | [Blog](https://www.dolthub.com/blog/2024-02-28-works-with-dolt-dotnet-webapp/) | [Code](https://github.com/dolthub/dolt-dotnet-webapp-sample) |
| [Django](https://www.djangoproject.com/) | Python | [Blog](https://www.dolthub.com/blog/2024-01-31-dolt-django/) | [Code](https://github.com/dolthub/dolt_django) |
| [Ecto](https://hexdocs.pm/ecto/Ecto.html) | Elixir | [Blog](https://www.dolthub.com/blog/2021-07-16-ecto-dolt/) | [Code](https://github.com/VinaiRachakonda/Ecto-Dolt-Sample) |
| [EF Core](https://learn.microsoft.com/en-us/ef/core/) | C# | [Blog](https://www.dolthub.com/blog/2023-12-04-works-with-dolt-efcore/) | [Code](https://github.com/dolthub/efcore-sample) |
| [GORM](https://gorm.io/docs/) | Golang | [Blog](https://www.dolthub.com/blog/2024-03-15-gorm-with-dolt) | [Code](https://github.com/dolthub/gorm-demo) |
| [Hibernate ](https://hibernate.org/) | Java | [Blog](https://www.dolthub.com/blog/2023-11-13-dolt-on-hibernate/) | [Code](https://github.com/dolthub/hibernate-sample) |
| [Knex.js](https://knexjs.org/) | Javascript | [Blog](https://www.dolthub.com/blog/2023-09-27-dolt-and-knexjs/) | [Code](https://github.com/dolthub/dolt-knexjs-example) |
| [EF Core](https://learn.microsoft.com/en-us/ef/core/) | C# | [Blog](https://www.dolthub.com/blog/2023-12-04-works-with-dolt-efcore/) | [Code](https://github.com/dolthub/efcore-sample) |
| [ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/introduction-to-aspnet-core) | C# | [Blog](https://www.dolthub.com/blog/2024-02-28-works-with-dolt-dotnet-webapp/) | [Code](https://github.com/dolthub/dolt-dotnet-webapp-sample) |
| [Laravel](https://laravel.com/) | PHP | [Blog](https://www.dolthub.com/blog/2024-01-08-dolt-laravel/) | [Code](https://github.com/dolthub/chirper) |
| [Ruby on Rails](https://rubyonrails.org/) | Ruby | [Blog](https://www.dolthub.com/blog/2024-02-09-dolt-ruby-on-rails/) | [Code](https://github.com/dolthub/dolt_rails) |
| [GORM](https://gorm.io/docs/) | Golang | [Blog](https://www.dolthub.com/blog/2024-03-15-gorm-with-dolt) | [Code](https://github.com/dolthub/gorm-demo) |
| [SQLAlchemy](https://www.sqlalchemy.org/) | Python | [Blog](https://www.dolthub.com/blog/2023-07-12-sql-alchemy-getting-started/) | [Code](https://github.com/timsehn/dolt-sqlalchemy-getting-started/tree/main) |
| [Shiny](https://shiny.posit.co/) | R | [Blog](https://www.dolthub.com/blog/2024-04-26-dolt-r-shiny/) | [Code](https://github.com/dolthub/dolt_shiny) |

## Tools

| Tool | Blog |
|----------------------------------------------------------------|------------------------------------------------------------------------------|
| [Apache Superset](https://superset.apache.org/) | [Blog](https://www.dolthub.com/blog/2023-01-27-dolt-superset/) |
| [Datadog](https://www.datadoghq.com/) | [Blog](https://www.dolthub.com/blog/2024-05-17-dolt-datadog-dashboards/) |
| [Datadog](https://www.datadoghq.com/) | [Blog](https://www.dolthub.com/blog/2024-05-17-dolt-datadog-dashboards/) |
| [Excel](https://www.microsoft.com/en-us/microsoft-365/excel) | [Blog](https://www.dolthub.com/blog/2023-11-24-dolt-excel) |
| [Google Sheets](https://www.google.com/sheets/about/#overview) | [Blog](https://www.dolthub.com/blog/2023-09-15-dolt-google-sheets/) |
| [Looker Studio](https://lookerstudio.google.com/) | [Blog](https://www.dolthub.com/blog/2023-02-13-dolt-looker/) |
| [MediaWiki](https://www.mediawiki.org/wiki/MediaWiki) | [Blog](https://www.dolthub.com/blog/2024-04-05-dolt-mediawiki-wikipedia/) |
| [Metabase](https://github.com/metabase/metabase) | [Blog](https://www.dolthub.com/blog/2024-01-24-dolt-metabase/) |
| [R Studio](https://posit.co/download/rstudio-desktop/) | [Blog](https://www.dolthub.com/blog/2022-02-14-dolt-and-r/) |
| [Retool](https://retool.com/) | [Blog](https://www.dolthub.com/blog/2023-01-03-superpower-retool-with-dolt/) |
| [WordPress](https://wordpress.com/) | [Blog](https://www.dolthub.com/blog/2023-08-04-wordpress-on-dolt/) |
| [XCA](https://hohnstaedt.de/xca/) | [Blog](https://www.dolthub.com/blog/2023-08-21-xca-on-dolt/) |
Original file line number Diff line number Diff line change
Expand Up @@ -713,6 +713,8 @@ the CLI, and takes the same arguments.
CALL DOLT_FETCH('origin', 'main');
CALL DOLT_FETCH('origin', 'feature-branch');
CALL DOLT_FETCH('origin', 'refs/heads/main:refs/remotes/origin/main');
CALL DOLT_FETCH('origin', NULL);
CALL DOLT_FETCH('origin');
```

### Options
Expand Down Expand Up @@ -742,6 +744,10 @@ SELECT HASHOF('origin/main');
CALL DOLT_MERGE('origin/main');
```

### Notes
Dropping the second argument, or passing NULL, will result is using the default refspec.


## `DOLT_GC()`

Cleans up unreferenced data from the database. Running the `dolt_gc` procedure on a Dolt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,8 @@ and update remote-tracking branches..
CALL DOLT_FETCH('origin', 'main');
CALL DOLT_FETCH('origin', 'feature-branch');
CALL DOLT_FETCH('origin', 'refs/heads/main:refs/remotes/origin/main');
CALL DOLT_FETCH('origin', NULL);
CALL DOLT_FETCH('origin');
```

### Options
Expand Down Expand Up @@ -727,6 +729,9 @@ SELECT HASHOF('origin/main');
CALL DOLT_MERGE('origin/main');
```

### Notes
Dropping the second argument, or passing NULL, will result is using the default refspec.

## `DOLT_GC()`

Cleans up unreferenced data from the database. Running the `dolt_gc` procedure on a Dolt
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion packages/doltlab/content/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
## Introduction

- [What is DoltLab?](introduction/what-is-doltlab.md)
- [Getting Started](introduction/getting-started.md)
- [Getting Started](introduction/getting-started/getting-started.md)
- [AWS](introduction/getting-started/aws.md)
- [Azure](introduction/getting-started/azure.md)
- [GCP](introduction/getting-started/gcp.md)

## Enterprise

Expand Down
84 changes: 84 additions & 0 deletions packages/doltlab/content/introduction/getting-started/aws.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Get a Ubuntu EC2 Instance

To get your DoltLab ready host on AWS:

1. Go to [AWS EC2 console](https://console.aws.amazon.com/ec2/) and click "Launch instance".

2. Select a Ubuntu 22.04 amd64 t2.xlarge instance.

![](../../.gitbook/assets/getting-started/doltlab-aws-ec2-instance-type.png)

3. Create a new RSA key pair for your instance in `.pem` format.

![](../../.gitbook/assets/getting-started/create-new-key-pair.png)

This will create a `.pem` file and download it locally.

3. Edit network settings and from the "Auto-assign public IP" drop-down menu choose "Enable".

![](../../.gitbook/assets/getting-started/doltlab-aws-ec2-pub-ip.png)

4. Add security group rules for ports 22 (SSH), 80 (HTTP), 443 (HTTPS), 100 (CUSTOM), 4321 (CUSTOM), 50051 (CUSTOM) that allow ingress from anywhere. Specifics [here](https://docs.doltlab.com/introduction/installation#networking-requirements). You also may need to create a new VPC and Subnet here. Just use the defaults.

![](../../.gitbook/assets/getting-started/doltlab-aws-ec2-security-rules.png)

5. Add 300GB gp3 disk.

![](../../.gitbook/assets/getting-started/doltlab-aws-ec2-storage.png)

6. Click "Launch instance".

![](../../.gitbook/assets/getting-started/doltlab-aws-ec2-launch-summary.png)

After this you should get a public IP for your new host. Mine was `54.191.163.60`.

# SSH to your New Host

Now I need to SSH to this host. I copy the `.pem` file I created when I launched the instance to my `.ssh` folder, give it appropriate permissions and then I can ssh to my new host.

```sh
$ cp ~/Downloads/doltlab.pem ~/.ssh
$ chmod 600 .ssh/doltlab.pem
$ ssh -i ~/.ssh/doltlab.pem [email protected]
Enter passphrase for key '/Users/timsehn/.ssh/y':
Welcome to Ubuntu 22.04.4 LTS (GNU/Linux 6.5.0-1014-aws x86_64)

* Documentation: https://help.ubuntu.com
* Management: https://landscape.canonical.com
* Support: https://ubuntu.com/pro

System information as of Thu Apr 25 17:17:23 UTC 2024

System load: 0.0185546875 Processes: 124
Usage of /: 0.5% of 339.02GB Users logged in: 0
Memory usage: 1% IPv4 address for eth0: 10.2.0.124
Swap usage: 0%

Expanded Security Maintenance for Applications is not enabled.

0 updates can be applied immediately.

Enable ESM Apps to receive additional future security updates.
See https://ubuntu.com/esm or run: sudo pro status


The list of available updates is more than a week old.
To check for new updates run: sudo apt update


The programs included with the Ubuntu system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.

Ubuntu comes with ABSOLUTELY NO WARRANTY, to the extent permitted by
applicable law.

To run a command as administrator (user "root"), use "sudo <command>".
See "man sudo_root" for details.

ubuntu@ip-10-2-0-124:~$
```

I'm in!

Now that you have a DoltLab ready host, [continue the Getting Started guide](./getting-started.md#download-doltlab-and-its-dependencies)
Loading
Loading