Skip to content

Commit

Permalink
Merge branch 'main' of github.com:AudiusProject/audius-protocol into …
Browse files Browse the repository at this point in the history
…jd/album-edit-premium

# Conflicts:
#	packages/common/src/hooks/useAccessAndRemixSettings.ts
  • Loading branch information
DejayJD committed Apr 10, 2024
2 parents f1df4e3 + 5b1f635 commit 34b2b5f
Show file tree
Hide file tree
Showing 131 changed files with 7,856 additions and 1,343 deletions.
23 changes: 13 additions & 10 deletions .circleci/src/workflows/web.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,19 @@ jobs:
only: /(^release.*)$/

# Distribute staging desktop binaries.
- web-dist-mac-staging:
context:
- Audius Client
- Vercel
- slack-secrets
requires:
- web-build-staging
filters:
branches:
only: /(^main)$/
# Mac Stage Desktop App deploys are skipped to prevent high
# CircleCI credit usage as they use the M1. Enable for one-off deploys
#
# - web-dist-mac-staging:
# context:
# - Audius Client
# - Vercel
# - slack-secrets
# requires:
# - web-build-staging
# filters:
# branches:
# only: /(^main)$/
- web-dist-win-staging:
context:
- Audius Client
Expand Down
10 changes: 10 additions & 0 deletions docs/.vscode/spellright.dict
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@ abi
audius
blockhash
ciphertexts
ddex
delegater
delegaters
docusaurus
erc
ern
ern3
ern4
esque
eth
ethereum
Expand All @@ -19,15 +23,20 @@ gravatar
img
io
ioredis
isrc
iswc
js
jwt
mainnet
metadatas
metamask
multisig
nft
nodejs
nonpayable
npm
oauth
oauthed
off-chain
on-chain
onclick
Expand All @@ -53,6 +62,7 @@ typehash
undelegate
unrepost
unstake
upc
userbase
wei
whitepaper
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

## Dev

```
```sh
npm install
npm run prepare:translations
npm start
```

To develop on cloudflare pages and test the whole stack, run:

```
```sh
npm run pages:dev
```

## Build

```
```sh
npm run build
```

Expand All @@ -26,16 +26,16 @@ Running the following commands will create a public test site to view your chang

To deploy to docs.audius.org, ensure the commands are run from the `main` branch.

```
```sh
npm run build
npm run pages:deploy
```

## Translate

```
```sh
npm run prepare:translations
```

This will write translations to the i18n folder.
If you modify markdown files while running the local dev server, you will need to prepare the translations as /i18n/en is the default entrypoint.
This will write translations to the i18n folder. If you modify markdown files while running the
local dev server, you will need to prepare the translations as /i18n/en is the default entrypoint.
54 changes: 54 additions & 0 deletions docs/docs/distributors/introduction/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
id: overview
title: Distributing Content to Audius
pagination_label: Distributing Content to Audius
sidebar_label: Overview
description: Audius Protocol Documentation
---

import useBaseUrl from '@docusaurus/useBaseUrl'

:::tip Looking for how to accept deliveries from your label or distributor?

Come back soon and check the [Audius Support Page](https://support.audius.co) for more information.

:::

Audius supports bulk content ingestion via the DDEX standard.

Providers, labels & partners with their own delivery infrastructure should reference the following
documentation for guidance on how to send and administer content on Audius.

If you're looking to build your own ingestion tooling, get started with the
[Audius SDK](/developers/sdk/overview).

## What is DDEX

Digital Data Exchange (or "DDEX") is an international standards-setting organization that was formed
in 2006 to develop standards that enable companies to communicate information along the digital
supply chain more efficiently by:

- Developing standard message and file formats (XML or flat-file)
- Developing choreographies for specific business transactions
- Developing communication protocols (SFTP or based on web services)
- Working with industry bodies to create a more efficient supply chain

:::info More Information

- Learn more on the official DDEX Website here: [https://ddex.net/](https://ddex.net/)
- Looking for a deeper technical dive? Checkout the DDEX knowledge base here:
[https://kb.ddex.net/](https://kb.ddex.net/)

:::

---

## Open Source

All DDEX ingestion code & libraries are open source and available on
[GitHub](https://github.com/AudiusProject/audius-protocol/tree/main/packages/ddex).

You may clone and self-operate your own Audius compatible DDEX ingestion server, which provides a
web interface to deliver files, manage uploads, and track success. Under the hood, DDEX ingestion
uses the [Audius SDK](/developers/sdk/overview) to process and upload tracks and is available in a
[self-service](/distributors/self-serve/overview) manner.
18 changes: 18 additions & 0 deletions docs/docs/distributors/self-serve/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
id: overview
title: Overview
pagination_label: Overview
sidebar_label: Overview
description: Audius Protocol Documentation
---

import useBaseUrl from '@docusaurus/useBaseUrl'

---

:::info

Content can be ingested into the Audius network by directly operating your own DDEX ingestion
server. More details soon.

:::
41 changes: 41 additions & 0 deletions docs/docs/distributors/self-serve/run-a-ddex-server.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: run-a-ddex-server
title: Running a DDEX Ingestion Server
pagination_label: Running a Server
sidebar_label: Running a Server
description: Audius Protocol Documentation
---

import useBaseUrl from '@docusaurus/useBaseUrl'

:::info Coming Soon!

Under construction. Please use as your own risk! 🚧

Check back soon for updates on how to run and operate own DDEX Ingestion Server.

:::

## Instructions

1. Provision a new machine following. We recommend:

- Ubuntu
- 8 CPUs
- 16 to 32GB Memory

2. Visit [audius-docker-compose](https://github.com/AudiusProject/audius-docker-compose) and run the
install script to set up your Audius environment on your provisioned machine.

3. Follow the instructions in the
[audius-protocol](https://github.com/AudiusProject/audius-protocol/tree/main/packages/ddex)
repository to set the appropriate environment variables

4. Start the DDEX Ingestion Server

```
audius-cli launch ddex
```

Your server will now be available at localhost:80 and is exposed via self-signed SSL on :443 if
`DDEX_URL` is set.
Loading

0 comments on commit 34b2b5f

Please sign in to comment.