Getting Started on a Local Computer
Use this page to try Buckit on the same macOS or Windows computer where you run Buckit Manager.
Buckit Manager downloads Buckit, creates the local files, and provides a launcher you use to start the server. It does not install Buckit as a background system service.
What You Need
Prepare the following before you begin:
A macOS or Windows computer with a web browser.
One or more local filesystem paths for Buckit object data.
Install Buckit Manager
Buckit Manager (bm) is the deployment and management tool for Buckit. It
provides the web interface and wizard used to prepare the local server.
Install bm on the macOS or Windows computer where you want to run Buckit.
curl -fsSL https://buckit-io.github.io/bm/install.sh | sh
irm https://buckit-io.github.io/bm/install.ps1 | iex
Start Buckit Manager
Run:
bm web
By default, Buckit Manager starts on http://127.0.0.1:9443/ and opens your
browser automatically.
Prepare the Local Deployment
After bm web starts, the browser opens Welcome to Buckit
Manager.
Select Deploy a new cluster.
Select This computer only.
Choose the Buckit version and enter the root user and root password.
Enter one or more local filesystem paths for storing object data, such as
/tmp/buckit/data{1...4}. The wizard creates missing paths.Review the settings and select Prepare deploy.
Buckit Manager downloads Buckit, verifies the checksum, creates missing data directories, writes the start script, and prepares the local configuration.
Start Buckit
After preparation finishes, Buckit Manager shows a command similar to one of the following:
~/buckit/local/start-buckit.sh
Run this command in PowerShell (press the Windows key, type
PowerShell, then select Windows PowerShell):
C:\Users\YOUR-USER-NAME\buckit\local\Start-Buckit.cmd
The Buckit server runs in that terminal session. Stop it with Ctrl+C.
Import the Local Deployment
After Buckit server starts successfully, use the import link shown on the Ready page to import the local deployment into Buckit Manager for easy monitoring and management.
Create Bucket and Upload Files in Admin Console
After import succeeds, Buckit Manager opens the cluster detail page.
From there:
Click the Open Buckit Console button on the top right of the page.
Sign in with the root credentials you set during preparation.
Select the Buckets menu on the left and create a new bucket.
Select the Object Browser menu on the left, open the new bucket, and upload one or more files.
Confirm that the uploaded objects appear in the bucket browser.
Download Files Using bm CLI
After the local deployment is imported, use the bm alias from the command
line to inspect the local deployment, list the uploaded objects, and copy one
file back to your local system.
List the configured aliases:
bm alias list
If the list is empty, create an alias manually. Replace {CLUSTER-ALIAS}
with a name for this local deployment, {API-URL} with the API address you
configured (for example, http://127.0.0.1:9000), and the credentials with
the root user and password you set during preparation:
bm alias set {CLUSTER-ALIAS} {API-URL} {ROOT-USER} {ROOT-PASSWORD}
For example, for a local deployment using the default API port:
bm alias set local http://127.0.0.1:9000 ROOT-USER ROOT-PASSWORD
Inspect the deployment. Replace {CLUSTER-ALIAS} with an alias from the
list, or the alias you created in the preceding step:
bm admin info {CLUSTER-ALIAS}
List the buckets on the deployment:
bm ls {CLUSTER-ALIAS}/
List the objects in the bucket you created. Replace {BUCKET} with the
bucket name from the last step:
bm ls {CLUSTER-ALIAS}/{BUCKET}
Copy one object from Buckit to your local system. Replace {OBJECT} with one
of the files you uploaded:
bm cp {CLUSTER-ALIAS}/{BUCKET}/{OBJECT} ./{OBJECT}
Next Steps
Learn the Buckit concepts in Core Operational Concepts
See the detailed local deployment guide in Deploy Buckit on Local Computer
