You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can follow the [documentation](./docs/index.md) to install and use Torrust Index Frontend for development. We will improve the documentation with:
76
+
You can use environment variables to customize the application infrastructure settings.
33
77
34
-
* Installation guide for production.
35
-
* Docker images and guides for using Torrust Index Frontend with docker for development and production.
78
+
```s
79
+
NUXT_PUBLIC_API_BASE="http://localhost:3001/v1" \
80
+
NITRO_HOST="0.0.0.0" \
81
+
NITRO_PORT="3000" \
82
+
npm run dev
83
+
```
84
+
85
+
> Please read our [container guide][containers] for more information.
86
+
87
+
### Production Version
88
+
89
+
You can run the production build in preview mode with the following:
90
+
91
+
```s
92
+
npm install && npm run build && npm run preview
93
+
```
94
+
95
+
### Services
96
+
97
+
The default configuration serves the web app on http://[::]:3000.
36
98
37
99
## Documentation
38
100
39
101
You can read the documentation [here](./docs/index.md).
40
102
41
103
## Contributing
42
104
43
-
We welcome contributions from the community!
105
+
We are happy to support and welcome new people to our project. Please consider our [contributor guide][contribution_guide].</br>
106
+
This is an open-source community-supported project. We welcome contributions from the community!
44
107
45
-
How can you contribute?
108
+
__How can you contribute?__
46
109
47
110
* Bug reports and feature requests.
48
-
* Code contributions. You can start by looking at the issues labeled ["good first issues"](https://github.com/torrust/torrust-index-gui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
49
-
* Documentation improvements. Check the [documentation](./docs/index.md) for typos, errors, or missing information.
50
-
* Participation in the community. You can help by answering questions in the [discussions](https://github.com/torrust/torrust-index-gui/discussions).
111
+
* Code contributions. You can start by looking at the issues labeled "[good first issues]".
112
+
* Documentation improvements. Check the [documentation][docs] for typos, errors, or missing information.
113
+
* Participation in the community. You can help by answering questions in the [discussions].
114
+
115
+
## License
51
116
52
-
Please report issues:
117
+
**Copyright (c) 2023 The Torrust Developers.**
53
118
54
-
* Torrust Index Frontend specifically: [here](https://github.com/torrust/torrust-index-gui/issues).
55
-
* Torrust Index in general: [here](https://github.com/torrust/torrust-index/issues).
119
+
This program is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License][AGPL_3_0] as published by the [Free Software Foundation][FSF], version 3.
This program is distributed in the hope that it will be useful, but __WITHOUT ANY WARRANTY__; without even the implied warranty of __MERCHANTABILITY__ or __FITNESS FOR A PARTICULAR PURPOSE__. See the [GNU Affero General Public License][AGPL_3_0] for more details.
58
122
59
-
## License
123
+
You should have received a copy of the *GNU Affero General Public License* along with this program. If not, see <https://www.gnu.org/licenses/>.
124
+
125
+
Some files include explicit copyright notices and/or license notices.
126
+
127
+
### Legacy Exception
128
+
129
+
For prosperity, versions of Torrust Tracker that are older than five years are automatically granted the [MIT-0][MIT_0] license in addition to the existing [AGPL-3.0-only][AGPL_3_0] license.
130
+
131
+
### Contributor Agreement
132
+
133
+
The copyright of the Torrust Tracker is retained by the respective authors.
134
+
135
+
__Contributors agree:__
136
+
137
+
* That all their contributions be granted a license(s) __compatible__ with the [Torrust Trackers License](#license).
138
+
**That all contributors signal __clearly__ and __explicitly__ any other compilable licenses if they are not: *[AGPL-3.0-only with the legacy MIT-0 exception](#license)*.
139
+
140
+
**The Torrust-Tracker project has no copyright assignment agreement.**
60
141
61
-
The project is licensed under a dual license. See [COPYRIGHT](./COPYRIGHT).
142
+
*We kindly ask you to take time and consider The Torrust Project [Contributor Agreement][agreement] in full.*
62
143
63
144
## Acknowledgments
64
145
65
-
This project was a joint effort by [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/), [Dutch Bits](https://dutchbits.nl) and collaborators. Thank you to you all!
146
+
This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus], [Dutch Bits][Dutch Bits] and collaborators. Thank you to you all!
Copy file name to clipboardExpand all lines: docs/containerization_guide.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Containers (Docker or Podman)
1
+
# Containerization Guide
2
2
3
3
-[Demo environment](#demo-environment)
4
4
-[Requirements](#requirements)
@@ -181,11 +181,11 @@ The format is: `--publish [optional_host_ip]:[host_port]:[container_port]/[optio
181
181
The default ports can be mapped with the following (IPv4 and IPv6):
182
182
183
183
```s
184
-
--publish 0.0.0.0:3000:3000/tcp \
185
-
--publish [::]:3000:3000/tcp
184
+
--publish "0.0.0.0:3000:3000/tcp" \
185
+
--publish "[::]:3000:3000/tcp"
186
186
```
187
187
188
-
> NOTE: Inside the container it is necessary to expose a socket with the wildcard address `0.0.0.0` so that it may be accessible from the host. Verify that the configuration that the sockets are wildcard.
188
+
> NOTE: Inside the container it is necessary to expose a socket with the wildcard address `0.0.0.0`or `[::]`so that it may be accessible from the host. Verify that the configuration that the sockets are wildcard.
0 commit comments