Open-source, secure environment with real-world tools for enterprise-grade agents.
Python agentaiai-agentai-agentscode-interpretercopilotdevelopmentdevtoolsgptgpt-4javascriptllmnextjsopenaipythonreactsoftwaretypescript
Update connect bucket docs page (#710)
Jakub Novák0a4ffb097793
diff --git a/apps/web/src/app/(docs)/docs/legacy/guide/connect-bucket/page.mdx b/apps/web/src/app/(docs)/docs/legacy/guide/connect-bucket/page.mdxdeleted file mode 100644index 2261b05b1..000000000--- a/apps/web/src/app/(docs)/docs/legacy/guide/connect-bucket/page.mdx+++ /dev/null@@ -1,185 +0,0 @@-# Connecting bucket to the sandbox--To enable persistence of the data in the sandbox we can use a bucket to store the data. We are leveraging the fuse file system to mount the bucket to the sandbox.--You will need to build a custom sandbox template with the fuse file system installed. The guide how to build a custom sandbox template can be found [here](/docs/guide/custom-sandbox).--## Google Cloud Storage--### Prerequisites--To use the Google Cloud Storage we'll need to have a bucket and a service account. The service account can be created [here](https://console.cloud.google.com/iam-admin/serviceaccounts), the bucket can be created [here](https://console.cloud.google.com/storage).--If you want to write to the bucket the service account must have the `Storage Object Admin` role for this bucket.--The guide how to create a service account key can be found [here](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console).--### Mounting the bucket--To use the Google Cloud Storage we need to install the `gcsfuse` package. There's simple `Dockerfile` that can be used to create a container with the `gcsfuse` installed.--```docker-FROM ubuntu:latest--RUN apt-get update && apt-get install -y gnupg lsb-release wget--RUN lsb_release -c -s > /tmp/lsb_release-RUN GCSFUSE_REPO=$(cat /tmp/lsb_release); echo "deb https://packages.cloud.google.com/apt gcsfuse-$GCSFUSE_REPO main" | tee /etc/apt/sources.list.d/gcsfuse.list-RUN wget -O - https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add ---RUN apt-get update && apt-get install -y gcsfuse--```--The actual mounting of the bucket is done in runtime during the start of the sandbox. The `gcsfuse` command is used to mount the bucket to the sandbox.--<CodeGroup isRunnable={false}>-```js {{ language: 'js' }}-import { Sandbox } from 'e2b'--const sandbox = await Sandbox.create({ template: '<your template id>' })-await sandbox.filesystem.makeDir("/home/user/bucket")-await sandbox.uploadFile("key.json")--const process = await sandbox.process.start("sudo gcsfuse <flags> --key-file /home/user/key.json <bucket-name> /home/user/bucket")-const output = await process.wait()-if (output.exitCode) {- throw Error(output.stderr)-}-```--```python {{ language: 'python' }}-from e2b import Sandbox--with Sandbox(template="<your template id>") as sandbox:- sandbox.filesystem.make_dir("/home/user/bucket")- sandbox.upload_file("key.json")-- process = sandbox.process.start("sudo gcsfuse <flags> --key-file /home/user/key.json <bucket-name> /home/user/bucket")- output = process.wait()- if output.exit_code:- raise Exception(output.stderr)--```-</CodeGroup>--### Flags--The list of all flags can be found [here](https://cloud.google.com/storage/docs/gcsfuse-cli#options).--### Allow the default user to access the files--To allow the default user to access the files we can use the following flags:--```--o allow_other -file-mode=777 -dir-mode=777-```--## Amazon S3--For Amazon S3 we can use the `s3fs` package. The `Dockerfile` is similar to the one for the Google Cloud Storage.--```docker-FROM ubuntu:latest--RUN apt-get update && apt-get install s3fs-```--Similarly to the Google Cloud Storage, the actual mounting of the bucket is done in runtime during the start of the sandbox. The `s3fs` command is used to mount the bucket to the sandbox.--<CodeGroup isRunnable={false}>-```js {{ language: 'js' }}-import { Sandbox } from 'e2b'--const sandbox = await Sandbox.create({ template: '<your template id>' })-await sandbox.filesystem.makeDir('/home/user/bucket')---// Create a file with the credentials-// If you use another path for the credentials you need to add the path in the command s3fs command-await sandbox.filesystem.write('/root/.passwd-s3fs', '<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>')-await sandbox.process.startAndWait('sudo chmod 600 /root/.passwd-s3fs')--const process = await sandbox.process.start('sudo s3fs <flags> <bucket-name> /home/user/bucket')-const output = await process.wait()-if (output.exitCode) {- throw Error(output.stderr)-}-```--```python {{ language: 'python' }}-from e2b import Sandbox--with Sandbox(template="<your template id>") as sandbox:- sandbox.filesystem.make_dir("/home/user/bucket")-- # Create a file with the credentials- # If you use another path for the credentials you need to add the path in the command s3fs command- sandbox.filesystem.write("/root/.passwd-s3fs", "<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>")- sandbox.process.start_and_wait("sudo chmod 600 /root/.passwd-s3fs")-- process = sandbox.process.start("sudo s3fs <flags> <bucket-name> /home/user/bucket")- output = process.wait()- if output.exit_code:- raise Exception(output.stderr)--```-</CodeGroup>--### Flags--The list of all flags can be found [here](https://manpages.ubuntu.com/manpages/xenial/man1/s3fs.1.html).--### Allow the default user to access the files--To allow the default user to access the files add the following flag:--```--o allow_other-```--## Cloudflare R2--For Cloudflare R2 we can use very similar setup as for S3. The `Dockerfile` is the same as for S3. The mounting is slightly different, we need to specify the endpoint for R2.--<CodeGroup isRunnable={false}>-```js {{ language: 'js' }}--import { Sandbox } from 'e2b'--const sandbox = await Sandbox.create({ template: '<your template id>' })-await sandbox.filesystem.makeDir('/home/user/bucket')--// Create a file with the R2 credentials-// If you use another path for the credentials you need to add the path in the command s3fs command-await sandbox.filesystem.write('/root/.passwd-s3fs', '<R2_ACCESS_KEY_ID>:<R2_SECRET_ACCESS_KEY>')-await sandbox.process.startAndWait('sudo chmod 600 /root/.passwd-s3fs')--const output = await sandbox.process.startAndWait('sudo s3fs -o url=https://<ACCOUNT ID>.r2.cloudflarestorage.com <flags> <bucket-name> /home/user/bucket')-if (output.exitCode) {- throw Error(output.stderr)-}-```--```python {{ language: 'python' }}-from e2b import Sandbox--with Sandbox(template="<your template id>") as sandbox:- sandbox.filesystem.make_dir("/home/user/bucket")-- # Create a file with the R2 credentials- # If you use another path for the credentials you need to add the path in the command s3fs command- sandbox.filesystem.write("/root/.passwd-s3fs", "<R2_ACCESS_KEY_ID>:<R2_SECRET_ACCESS_KEY>")- sandbox.process.start_and_wait("sudo chmod 600 /root/.passwd-s3fs")-- process = sandbox.process.start("sudo s3fs -o url=https://<ACCOUNT ID>.r2.cloudflarestorage.com <flags> <bucket-name> /home/user/bucket")- output = process.wait()- if output.exit_code:- raise Exception(output.stderr)--```-</CodeGroup>--### Flags--It's the same as for S3.\ No newline at end of filediff --git a/apps/web/src/app/(docs)/docs/sandbox/connect-bucket/page.mdx b/apps/web/src/app/(docs)/docs/sandbox/connect-bucket/page.mdxnew file mode 100644index 000000000..d742ba1f7--- /dev/null+++ b/apps/web/src/app/(docs)/docs/sandbox/connect-bucket/page.mdx@@ -0,0 +1,163 @@+# Connecting bucket to the sandbox++To connect a bucket for storing data from the sandbox, we will use the FUSE file system to mount the bucket to the sandbox.++You will need to create a custom sandbox template with the FUSE file system installed. The guide for building a custom sandbox template can be found [here](/docs/sandbox-template).++## Google Cloud Storage+### Prerequisites++To use Google Cloud Storage, you'll need a bucket and a service account. You can create a service account [here](https://console.cloud.google.com/iam-admin/serviceaccounts) and a bucket [here](https://console.cloud.google.com/storage).++If you want to write to the bucket, make sure the service account has the `Storage Object User` role for this bucket.++You can find a guide on creating a service account key [here](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console).++### Mounting the bucket++To use the Google Cloud Storage we need to install the `gcsfuse` package. There's simple `Dockerfile` that can be used to create a container with the `gcsfuse` installed.++```docker+FROM e2bdev/code-interpreter:latest++RUN apt-get update && apt-get install -y gnupg lsb-release wget++RUN lsb_release -c -s > /tmp/lsb_release+RUN GCSFUSE_REPO=$(cat /tmp/lsb_release) && echo "deb https://packages.cloud.google.com/apt gcsfuse-$GCSFUSE_REPO main" | tee /etc/apt/sources.list.d/gcsfuse.list+RUN wget -O - https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add -++RUN apt-get update && apt-get install -y gcsfuse++```++The bucket is mounted during the sandbox runtime using the `gcsfuse` command.++<CodeGroup isRunnable={false}>+```js {{ language: 'js' }}+import { Sandbox } from 'e2b'++const sandbox = await Sandbox.create('<your template id>')+await sandbox.files.makeDir('/home/user/bucket')+await sandbox.files.write('key.json', '<your service account key>')++await sandbox.commands.run('sudo gcsfuse <flags> --key-file /home/user/key.json <bucket-name> /home/user/bucket')+```++```python {{ language: 'python' }}+from e2b import Sandbox++sandbox = Sandbox("<your template id>")+sandbox.files.make_dir("/home/user/bucket")+sandbox.files.write("key.json", "<your key file content>")++output = sandbox.commands.run(+ "sudo gcsfuse <flags> --key-file /home/user/key.json <bucket-name> /home/user/bucket"+)+```+</CodeGroup>++### Flags++The complete list of flags is available [here](https://cloud.google.com/storage/docs/gcsfuse-cli#options).++### Allow the default user to access the files++To allow the default user to access the files, we can use the following flags:++```+-o allow_other -file-mode=777 -dir-mode=777+```++## Amazon S3++To use Amazon S3, we can use the `s3fs` package. The `Dockerfile` setup is similar to that of Google Cloud Storage.++```docker+FROM ubuntu:latest++RUN apt-get update && apt-get install s3fs+```++Similar to Google Cloud Storage, the bucket is mounted during the runtime of the sandbox. The `s3fs` command is used to mount the bucket to the sandbox.++<CodeGroup isRunnable={false}>+```js {{ language: 'js' }}+import { Sandbox } from 'e2b'++const sandbox = await Sandbox.create('<your template id>')+await sandbox.files.makeDir('/home/user/bucket')++// Create a file with the credentials+// If you use another path for the credentials you need to add the path in the command s3fs command+await sandbox.files.write('/root/.passwd-s3fs', '<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>')+await sandbox.commands.run('sudo chmod 600 /root/.passwd-s3fs')++await sandbox.commands.run('sudo s3fs <flags> <bucket-name> /home/user/bucket')+```++```python {{ language: 'python' }}+from e2b import Sandbox++sandbox = Sandbox("<your template id>")+sandbox.files.make_dir("/home/user/bucket")++# Create a file with the credentials+# If you use another path for the credentials you need to add the path in the command s3fs command+sandbox.files.write("/root/.passwd-s3fs", "<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>")+sandbox.commands.run("sudo chmod 600 /root/.passwd-s3fs")++sandbox.commands.run("sudo s3fs <flags> <bucket-name> /home/user/bucket")+```+</CodeGroup>++### Flags++The complete list of flags is available [here](https://manpages.ubuntu.com/manpages/xenial/man1/s3fs.1.html).++### Allow the default user to access the files++To allow the default user to access the files, add the following flag:++```+-o allow_other+```++## Cloudflare R2++For Cloudflare R2, we can use a setup very similar to S3. The `Dockerfile` remains the same as for S3. However, the mounting differs slightly; we need to specify the endpoint for R2.++<CodeGroup isRunnable={false}>+```js {{ language: 'js' }}+import { Sandbox } from 'e2b'++const sandbox = await Sandbox.create({ template: '<your template id>' })+await sandbox.files.makeDir('/home/user/bucket')++// Create a file with the R2 credentials+// If you use another path for the credentials you need to add the path in the command s3fs command+await sandbox.files.write('/root/.passwd-s3fs', '<R2_ACCESS_KEY_ID>:<R2_SECRET_ACCESS_KEY>')+await sandbox.commands.run('sudo chmod 600 /root/.passwd-s3fs')++await sandbox.commands.run('sudo s3fs -o url=https://<ACCOUNT ID>.r2.cloudflarestorage.com <flags> <bucket-name> /home/user/bucket')+```++```python {{ language: 'python' }}+from e2b import Sandbox++sandbox = Sandbox("<your template id>")+sandbox.files.make_dir("/home/user/bucket")++# Create a file with the R2 credentials+# If you use another path for the credentials you need to add the path in the command s3fs command+sandbox.files.write("/root/.passwd-s3fs", "<R2_ACCESS_KEY_ID>:<R2_SECRET_ACCESS_KEY>")+sandbox.commands.run("sudo chmod 600 /root/.passwd-s3fs")++sandbox.commands.run(+ "sudo s3fs -o url=https://<ACCOUNT ID>.r2.cloudflarestorage.com <flags> <bucket-name> /home/user/bucket"+)+```+</CodeGroup>++### Flags++It's the same as for S3.diff --git a/apps/web/src/components/Navigation/routes.tsx b/apps/web/src/components/Navigation/routes.tsxindex 4fa961828..28a47506d 100644--- a/apps/web/src/components/Navigation/routes.tsx+++ b/apps/web/src/components/Navigation/routes.tsx@@ -310,6 +310,10 @@ export const docRoutes: NavGroup[] = [title: 'Internet access',href: '/docs/sandbox/internet-access',},+ {+ title: 'Connecting bucket',+ href: '/docs/sandbox/connect-bucket',+ },{title: 'Installing beta SDKs',href: '/docs/sandbox/installing-beta-sdks',