Consolidate documentation onto site homepage and update relevant links.
This commit is contained in:
Buster Neece
parent
b95449064a
commit
eea56852eb
|
|
@ -1,73 +1,7 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
All repositories in the AzuraCast organization adhere to the Contributor Covenant code of conduct. We expect all
|
||||
interactions across all media, including our GitHub issues and public social media channels, to adhere to these
|
||||
guidelines.
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, nationality, personal
|
||||
appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at help@azuracast.com. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
Visit [the AzuraCast web site]() for the full text of our Code of Conduct.
|
||||
|
|
|
|||
134
SUPPORT.md
134
SUPPORT.md
|
|
@ -1,135 +1,5 @@
|
|||
# Support for AzuraCast
|
||||
|
||||
**Note:** This support document is specific to users of our standard installation method (using Docker). If you're using the Ansible ("traditional" or "bare-metal") installation, see [this support guide](https://github.com/AzuraCast/azuracast.com/blob/master/LegacySupport.md) instead.
|
||||
We've centralized all of our help and common support issues to a single location on our homepage. Click the link below for more information.
|
||||
|
||||
Having trouble with your AzuraCast installation? These pointers may be able to help.
|
||||
|
||||
If you still don't find what you're looking for, check the GitHub Issues section for an existing issue relating to the
|
||||
one you're experiencing. If one does not exist, create a new one.
|
||||
|
||||
## Troubleshooting by Viewing Logs
|
||||
|
||||
Before submitting any GitHub issues, you should take a look at the terminal logs that AzuraCast outputs. They can often provide additional information about the error, or include very useful information that should be included in any GitHub issue you create.
|
||||
|
||||
Users with the appropriate permissions can also view many logs directly through AzuraCast itself. The Log Viewer feature is available under "Utilities" in each station's management page.
|
||||
|
||||
From the directory where your `docker-compose.yml` file is located, you can run:
|
||||
|
||||
```bash
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
This command will show you a running log of all containers. You can also get detailed logs by running `docker-compose logs -f service`, where "service" is one of `web`, `stations`, etc.
|
||||
|
||||
## Common Solutions
|
||||
|
||||
### Reset an Account Password
|
||||
|
||||
If you have lost the password to log into an account, but still have access to the SSH terminal for the server, you can
|
||||
execute the following command to generate a new random password for an account in the system.
|
||||
|
||||
Replace `YOUREMAILADDRESS` with the e-mail address whose password you intend to reset.
|
||||
|
||||
```bash
|
||||
./docker.sh cli azuracast:account:reset-password YOUREMAILADDRESS
|
||||
```
|
||||
|
||||
### Manually Flush the System Cache
|
||||
|
||||
Many parts of the AzuraCast system depend on caches to speed up site performance. Sometimes, these caches can get out of
|
||||
date, and they may cause errors. You can always flush all site-wide caches using one command-line script:
|
||||
|
||||
```bash
|
||||
./docker.sh cli cache:clear
|
||||
```
|
||||
|
||||
### Access Files via SFTP
|
||||
|
||||
By default, SFTP access isn't set up for Docker based installations. If you have a large volume of media files, you may
|
||||
prefer to upload them via SFTP instead of using the web updater. You should *not* use the host operating system's SFTP,
|
||||
however, as Docker stores station media inside a Docker-specific volume.
|
||||
|
||||
The script below will set up a temporary SFTP server that points to your station media directory inside Docker. The server
|
||||
will stay running inside the terminal window, so you can easily hit `Ctrl+C` to terminate it when you are finished.
|
||||
|
||||
```bash
|
||||
docker run --rm \
|
||||
-v azuracast_station_data:/home/azuracast/stations \
|
||||
-p 2222:22 atmoz/sftp:alpine \
|
||||
azuracast:4zur4c457:1000::stations
|
||||
```
|
||||
|
||||
As long as you leave this script running, it will create a connection that you can access with these credentials:
|
||||
|
||||
* **Host:** Your server's host name
|
||||
* **Port:** `2222` (Set in the third line)
|
||||
* **Username:** `azuracast` (The first part of the last line)
|
||||
* **Password:** `4zur4c457` (The second part of the last line)
|
||||
|
||||
If you intend to leave this script running for long term periods, you must change the password to something more secure.
|
||||
|
||||
### Use Non-standard Ports
|
||||
|
||||
You may want to serve the AzuraCast web application itself on a different port, or host your radio station on a port that
|
||||
isn't within the default range AzuraCast serves (8000-8999).
|
||||
|
||||
To change the ports on which AzuraCast serves HTTP and HTTPS traffic, you can edit the `.env` file on the host to modify the public-facing port numbers as needed. (Note: this file should already exist on your system, but if it doesn't, you can [use this version for reference](https://github.com/AzuraCast/AzuraCast/blob/master/.env).)
|
||||
|
||||
Modify (or create) the lines below to modify your port mappings:
|
||||
|
||||
```
|
||||
AZURACAST_HTTP_PORT=80
|
||||
AZURACAST_HTTPS_PORT=443
|
||||
```
|
||||
|
||||
You can either specify a single number (i.e. 8080) for each value, or specify "127.0.0.1:8080" to only listen on the localhost. This can be useful when AzuraCast is hosted behind a proxy on your host.
|
||||
|
||||
You will need to recycle your Docker containers using `docker-compose down`, then `docker-compose up -d` to apply any changes made to this file.
|
||||
|
||||
To override more complex functionality in your Docker installation, see the "Customizing Docker" section below.
|
||||
|
||||
### Expand the Docker Radio Station Port Range
|
||||
|
||||
For performance reasons, by default Docker installations only open radio ports from port 8000 to 8099. This allows for 10 unique stations to operate.
|
||||
|
||||
You can certainly run more than 10 stations on one AzuraCast instance, but if you want to directly access the additional radio ports, you can follow this simple process.
|
||||
|
||||
In the same folder where your Docker installation is (if using recommended instructions, this is `/var/azuracast`), create a new file named `docker-compose.override.yml`.
|
||||
|
||||
In this file, paste the following contents:
|
||||
|
||||
```yaml
|
||||
version: '2.2'
|
||||
|
||||
services:
|
||||
stations:
|
||||
ports:
|
||||
- "8500-8999:8500-8999"
|
||||
```
|
||||
|
||||
You can modify the port range in this file to meet your needs, such as expanding it to port 8999 instead of 8500.
|
||||
|
||||
You will need to recycle your Docker containers using `docker-compose down`, then `docker-compose up -d` to apply any changes made to this file.
|
||||
|
||||
## Customizing Docker
|
||||
|
||||
Docker installations come with four files by default:
|
||||
|
||||
- `docker.sh`, the [Docker Utility Script](https://www.azuracast.com/docker_sh.html);
|
||||
- `.env`, which contains environment variables used by Docker Compose itself;
|
||||
- `azuracast.env`, which contains customizable environment variables sent to AzuraCast and related services; and
|
||||
- `docker-compose.yml`, a large file that defines all of the services used by AzuraCast and how they interact.
|
||||
|
||||
For power users looking to customize or expand their Docker configuration, you should follow these best practices:
|
||||
|
||||
- Do not modify or replace the `docker.sh` utility script.
|
||||
|
||||
- When updating (using the `docker.sh` utility script), it is recommended to run `./docker-sh update-self` before running `./docker.sh update`, to ensure the Docker Utility Script itself is up to date before it updates your Docker installation.
|
||||
|
||||
- Environment variables set in `.env` are only used by Docker Compose itself, and aren't passed directly into the AzuraCast containers. You should only modify this file to change the HTTP and HTTPS port mappings used by Nginx (see the "Use Non-Standard Ports" section above).
|
||||
|
||||
- The `azuracast.env` file is specific to your environment and can be customized however you like. It will not be replaced during any updates. Once your database has been created, however, changing the password listed in this file will cause the system to fail. If you want to destructively wipe your existing database and other files and set up a new one with the updated password, add the `-v` flag to the end of `docker-compose down` to remove all existing volumes, including your database.
|
||||
|
||||
- If possible, you should not directly modify `docker-compose.yml`, as some updates may modify how it is defined to resolve bugs or add new features. When updating, you will always be asked if you want to update this file; if you have not modified it, you should always do so.
|
||||
|
||||
- Instead of modifying `docker-compose.yml`, you can create a file named `docker-compose.override.yml` with your customizations. The structure of this file is the same as the main `docker-compose.yml` file, and is automatically parsed by Docker Compose to override any definitions in the main file. Updates will not replace this file.
|
||||
- [AzuraCast Help Page](https://www.azuracast.com/help/)
|
||||
|
|
|
|||
|
|
@ -210,7 +210,7 @@ return [
|
|||
StationPlaylist::TYPE_ONCE_PER_X_SONGS => '<b>' . __('Once per x Songs') . ':</b> ' . __('Play exactly once every <i>x</i> songs.'),
|
||||
StationPlaylist::TYPE_ONCE_PER_X_MINUTES => '<b>' . __('Once Per x Minutes') . ':</b> ' . __('Play exactly once every <i>x</i> minutes.'),
|
||||
StationPlaylist::TYPE_ONCE_PER_HOUR => '<b>'.__('Once per Hour') . ':</b> '.__('Play once per hour at the specified minute.'),
|
||||
StationPlaylist::TYPE_ADVANCED => '<b>' . __('Advanced') .'</b>: ' . __('Manually define how this playlist is used in Liquidsoap configuration. <a href="%s" target="_blank">Learn about Advanced Playlists</a>', 'https://github.com/AzuraCast/azuracast.com/blob/master/AdvancedPlaylists.md'),
|
||||
StationPlaylist::TYPE_ADVANCED => '<b>' . __('Advanced') .'</b>: ' . __('Manually define how this playlist is used in Liquidsoap configuration. <a href="%s" target="_blank">Learn about Advanced Playlists</a>', 'https://www.azuracast.com/help/advanced_playlists.html'),
|
||||
],
|
||||
'default' => StationPlaylist::TYPE_DEFAULT,
|
||||
'required' => true,
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ echo $assets->js();
|
|||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="dropdown-item" href="https://www.azuracast.com/help.html" target="_blank">
|
||||
<a class="dropdown-item" href="https://www.azuracast.com/help/" target="_blank">
|
||||
<i class="material-icons" aria-hidden="true">help</i>
|
||||
<?=__('Help') ?>
|
||||
</a>
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ $assets
|
|||
</div>
|
||||
|
||||
<?php if (APP_INSIDE_DOCKER): ?>
|
||||
<p><i class="material-icons sm">info</i> <?=sprintf(__('You can also upload files in bulk via SFTP by <a href="%s" target="_blank">following these instructions</a>. Newly uploaded files will automatically be processed within a few minutes.'), 'https://github.com/AzuraCast/AzuraCast/blob/master/SUPPORT.md#access-files-via-sftp-docker-installations') ?></p>
|
||||
<p><i class="material-icons sm">info</i> <?=sprintf(__('You can also upload files in bulk via SFTP by <a href="%s" target="_blank">following these instructions</a>. Newly uploaded files will automatically be processed within a few minutes.'), 'https://www.azuracast.com/help/faq_docker.html#access-files-via-sftp') ?></p>
|
||||
<?php endif; ?>
|
||||
|
||||
<div id="upload_progress"></div>
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@
|
|||
</dd>
|
||||
</dl>
|
||||
|
||||
<p><?=sprintf(__('Setup instructions for broadcasting software are available <a href="%s" target="_blank">on the AzuraCast Wiki</a>.'), 'https://github.com/AzuraCast/azuracast.com/blob/master/StreamingSoftware.md') ?></p>
|
||||
<p><?=sprintf(__('Setup instructions for broadcasting software are available <a href="%s" target="_blank">on the AzuraCast Wiki</a>.'), 'https://www.azuracast.com/help/streaming_software.html') ?></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue