Getting started
To access your own hosted registries and use the workflow as well as security features of Bytesafe, you’ll first have to create an account and configure your client.
This is done in less than a minute by following the steps below.
Create your account & sign in
Go to Bytesafe Signup and select the account name that you would like to use. This will be part of the domain name used to access Bytesafe.
The next step is to create an admin user for your new account. You can sign up either with social logins (Google or GitHub) or using email & password. After account creation has been completed, you will be signed in to your new account and access the Bytesafe console.
To access your account with an existing user, go to
https://<your-account-name>.bytesafe.dev or enter your account name when signing in.
Congratulations! Your first private registry default is automatically created and is ready to be used.
Login to Bytesafe and authenticate
To access your registry using npm, yarn or pnpm, first login using your Bytesafe registry credentials (available in the Bytesafe web console).
After login, tokens are stored in the file .npmrc which is used by all the common clients.
Make sure authentication credentials are always sent to the Bytesafe server with
npm config set always-auth true
Login to your private Bytesafe registry
npm --registry 'https://example.bytesafe.dev/r/default/' login
Use the trailing / after the registry to avoid issues with different versions of npm.
You will be prompted for the user name, password and an email address. The email address is not used by Bytesafe, but is required by the clients.
Username: bytesafe
Password:
Email(this IS public): example@example.com
Logged in as bytesafe on https://example.bytesafe.dev/r/default/.
Make sure authentication credentials are always sent to the Bytesafe server with
npm config set always-auth true
Login to your private Bytesafe registry
npm --registry 'https://example.bytesafe.dev/r/default/' login
Note the trailing / after the registry which is required when using yarn.
You will need to use npm login to authenticate as yarn login does not ask for a password during login.
You will be prompted for the user name, password and an email address. The email address is not used by Bytesafe, but is required by the clients.
Username: bytesafe
Password:
Email(this IS public): example@example.com
Logged in as bytesafe on https://example.bytesafe.dev/r/default/.
Make sure authentication credentials are always sent to the Bytesafe server with
npm config set always-auth true
Login to your private Bytesafe registry
pnpm login --registry 'https://example.bytesafe.dev/r/default/'
Note the trailing / after the registry which is required when using pnpm.
You will be prompted for the user name, password and an email address. The email address is not used by Bytesafe, but is required by the clients.
Username: bytesafe
Password:
Email(this IS public): example@example.com
Logged in as bytesafe on https://example.bytesafe.dev/r/default/.
Install or publish a package
To install npm packages using npm, see the example below.
The Bytesafe web console will show all package dependencies which are downloaded and stored in your registry default.
npm --registry 'https://example.bytesafe.dev/r/default/' install <package>
If you have previously installed a package you might want to use the —-no-cache argument to make sure packages are downloaded from Bytesafe and avoid using the local cache .
Publish your npm packages with npm. If you would like to publish a package to your Bytesafe registry, look at the example below.
npm --registry 'https://example.bytesafe.dev/r/default/' publish <package>
To add npm packages using yarn, see the example below.
The Bytesafe web console will show all package dependencies which are downloaded and stored in your registry default.
yarn --registry 'https://example.bytesafe.dev/r/default/' add <package>
If you have previously installed a package you might want to execute yarn cache clean [<module_name…>] to make sure packages are downloaded from Bytesafe and avoid using the local cache .
Publish your npm packages with yarn. If you would like to publish a package to your Bytesafe registry, look at the example below.
yarn --registry 'https://example.bytesafe.dev/r/default/' publish <package>
Note the trailing / after the registry which is required when using yarn.
To add npm packages using pnpm, see the example below.
The Bytesafe web console will show all package dependencies which are downloaded and stored in your registry default.
pnpm add <package> --registry 'https://example.bytesafe.dev/r/default/'
Publish your npm packages with pnpm. If you would like to publish a package to your Bytesafe registry, look at the example below.
pnpm publish <package> --registry 'https://example.bytesafe.dev/r/default/'
Note the trailing / after the registry which is required when using pnpm.
Also note that pnpm publish command requires the registry flag to follow after publish
That’s it!
Great! You have now used packages with your own private Bytesafe registry. With this you are already making good progress in screening your dependencies and creating a safer code supply chain.
Make sure to explore the other features of Bytesafe such as upstreams, plugins, policies and integrations. Also invite your team members to join you.
Optional configuration
If you want better control over the flow of packages in and out of your organization, we recommend you to read how to configure and set one of your registries as your default registry.