Docker lol US

DOCKR

STARTIN WIF VERSHUN 3.0.3.2, ASF IZ NAO ALSO AVAILABLE AS DOCKR CONTAINR. R DOCKR PACKAGEZ R CURRENTLY AVAILABLE ON ghcr.io AS WELL AS DOCKR HUB.

It's important to note that running ASF in Docker container is considered advanced setup, which is not needed for vast majority of users, and typically gives no advantages over container-less setup. If you're considering Docker as a solution for running ASF as a service, then you should consider reading management section instead and set up a proper systemd service which will almost always be a better idea than running ASF in a Docker container.

While running ASF in docker container typically has no advantages for casual users (and causing several new problems on top of it), there are still valid use cases for it in very complex setups, for example in regards to advanced networking setup or security beyond standard sandboxing that ASF comes with in systemd service (which already ensures basic process isolation through very advanced security mechanics). For those handful amount of people, this section explains better ASF concepts in regards to its Docker compatibility.

WHICH TAG IZ TEH BEST 4 ME?

DAT DEPENDZ ON WUT URE LOOKIN 4. 4 MAJORITY OV USERS, latest TAG SHUD BE TEH BEST WAN AS IT OFFERS EGSAKTLY WUT DESKTOP ASF DOEZ, JUS IN SPESHUL DOCKR CONTAINR AS SERVICE. PEEPS DAT R REBUILDIN THEIR IMAGEZ QUITE OFTEN AN WUD INSTEAD PREFR FULL CONTROL WIF ASF VERSHUN TID 2 GIVEN RELEASE R WELCOM 2 USE released TAG. IF U INSTEAD WANTS 2 USE SUM SPECIFIC FROZEN ASF VERSHUN DAT WILL NEVR CHANGE WITHOUT UR CLEAR INTENSHUN, A.B.C.D RELEASEZ R AVAILABLE 4 U AS FIXD ASF MILESTONEZ U CAN ALWAYS FALL BAK 2.

WE GENERALLY DISCOURAGE TRYIN main BUILDZ, AS DOSE R HER 4 US 2 MARK CURRENT STATE OV ASF PROJECT. NOTHIN GUARANTEEZ DAT SUCH STATE WILL WERK PROPERLY, BUT OV COURSE URE MOAR THAN WELCOM 2 GIV THEM TRY IF URE INTERESTD IN ASF DEVELOPMENT.

ARCHITECTUREZ

ASF DOCKR IMAGE IZ CURRENTLY BUILT ON linux PLATFORM WIF 3 ARCHITECTUREZ - x64, arm AN arm64. U CAN READ MOAR BOUT THEM IN COMPATIBILITY SECSHUN.

SINCE ASF VERSHUN V5.0.2.2, R TAGS R USIN MULTI-PLATFORM MANIFEST, WHICH MEANZ DAT DOCKR INSTALLD ON UR MACHINE WILL AUTOMATICALLY SELECT TEH PROPR IMAGE 4 UR PLATFORM WHEN PULLIN TEH IMAGE. IF BY ANY CHANCE UD LIEK 2 PULL SPECIFIC PLATFORM IMAGE WHICH DOESNT MATCH TEH WAN URE CURRENTLY RUNNIN, U CAN DO DAT THRU --platform SWITCH IN APPROPRIATE DOCKR COMMANDZ, SUCH AS docker run. C DOCKR DOCUMENTASHUN ON IMAGE MANIFEST 4 MOAR INFO.

USAGE

4 COMPLETE REFERENCE U SHUD USE OFFISHUL DOCKR DOCUMENTASHUN, WELL COVR ONLY BASIC USAGE IN DIS GUIDE, URE MOAR THAN WELCOM 2 DIG DEEPR.

Y HALO THAR ASF!

FIRSTLY WE SHUD VERIFY IF R DOCKR IZ EVEN WERKIN RITE, DIS WILL SERVE AS R ASF "Y HALO THAR WURLD":

docker run -it --name asf --pull always --rm justarchi/archisteamfarm

docker run CREATEZ NEW ASF DOCKR CONTAINR 4 U AN RUNS IT IN DA FOREGROUND (-it). --pull always ENSUREZ DAT UP-2-DATE IMAGE WILL BE PULLD FURST, AN --rm ENSUREZ DAT R CONTAINR WILL BE PURGD ONCE STOPPD, SINCE WERE JUS TESTIN IF EVRYTHIN WERKZ FINE 4 NAO.

IF EVRYTHIN ENDD SUCCESFULLY, AFTR PULLIN ALL LAYERS AN STARTIN CONTAINR, U SHUD NOTICE DAT ASF PROPERLY STARTD AN INFORMD US DAT THAR R NO DEFIND BOTS, WHICH IZ GUD - WE VERIFID DAT ASF IN DOCKR WERKZ PROPERLY. HIT CTRL+P DEN CTRL+Q IN ORDR 2 QUIT FOREGROUND DOCKR CONTAINR, DEN STOP ASF CONTAINR WIF docker stop asf.

IF U TAEK CLOSR LOOK AT TEH COMMAND DEN ULL NOTICE DAT WE DIDNT DECLARE ANY TAG, WHICH AUTOMATICALLY DEFAULTD 2 latest WAN. IF U WANTS 2 USE OTHR TAG THAN latest, 4 EXAMPLE released, DEN U SHUD DECLARE IT EXPLICITLY:

docker run -it --name asf --pull always --rm justarchi/archisteamfarm:released

USIN VOLUME

IF URE USIN ASF IN DOCKR CONTAINR DEN OBVIOUSLY U NED 2 CONFIGURE TEH PROGRAM ITSELF. U CAN DO IT IN VARIOUS DIFFERENT WAYS, BUT TEH RECOMMENDD WAN WUD BE 2 CREATE ASF config DIRECTORY ON LOCAL MACHINE, DEN MOUNT IT AS SHARD VOLUME IN ASF DOCKR CONTAINR.

4 EXAMPLE, WELL ASSUME DAT UR ASF CONFIG FOLDR IZ IN /home/archi/ASF/config DIRECTORY. DIS DIRECTORY CONTAINS CORE ASF.json AS WELL AS BOTS DAT WE WANTS 2 RUN. NAO ALL WE NED 2 DO IZ SIMPLY ATTACHIN DAT DIRECTORY AS SHARD VOLUME IN R DOCKR CONTAINR, WER ASF EXPEX ITZ CONFIG DIRECTORY (/app/config).

docker run -it -v /home/archi/ASF/config:/app/config --name asf --pull always justarchi/archisteamfarm

AN THAZ IT, NAO UR ASF DOCKR CONTAINR WILL USE SHARD DIRECTORY WIF UR LOCAL MACHINE IN READ-RITE MODE, WHICH IZ EVRYTHIN U NED 4 CONFIGURIN ASF. IN SIMILAR WAI U CAN MOUNT OTHR VOLUMEZ DAT UD LIEK 2 SHARE WIF ASF, SUCH AS /app/logs OR /app/plugins.

OV COURSE, DIS AR TEH JUS WAN SPECIFIC WAI 2 ACHIEVE WUT WE WANTS, NOTHIN IZ STOPPIN U FRUM E.G. CREATIN UR OWN Dockerfile DAT WILL COPY UR CONFIG FILEZ INTO /app/config DIRECTORY INSIDE ASF DOCKR CONTAINR. WERE ONLY COVERIN BASIC USAGE IN DIS GUIDE.

VOLUME PERMISHUNS

ASF CONTAINR BY DEFAULT IZ INITIALIZD WIF DEFAULT root USR, WHICH ALLOWS IT 2 HANDLE TEH INTERNAL PERMISHUNS STUFF AN DEN EVENTUALLY SWITCH 2 asf (UID 1000) USR 4 DA REMAININ PART OV TEH MAIN PROCES. WHILE DIS SHUD BE SATISFYIN 4 DA VAST MAJORITY OV USERS, IT DOEZ AFFECT TEH SHARD VOLUME AS NEWLY-GENERATD FILEZ WILL BE NORMALLY OWND BY asf USR, WHICH CUD NOT BE DESIRD SITUASHUN IF UD LIEK SUM OTHR USR 4 UR SHARD VOLUME.

DOCKR ALLOWS U 2 PAS --user FLAG 2 docker run COMMAND WHICH WILL DEFINE DEFAULT USR DAT ASF WILL RUN UNDR. U CAN CHECK UR uid AN gid 4 EXAMPLE WIF id COMMAND, DEN PAS IT 2 TEH REST OV TEH COMMAND. 4 EXAMPLE, IF UR TARGET USR HAS uid AN gid OV 1001:

docker run -it -u 1001:1001 -v /home/archi/ASF/config:/app/config --name asf --pull always justarchi/archisteamfarm

REMEMBR DAT BY DEFAULT /app DIRECTORY USD BY ASF IZ STILL OWND BY asf. IF U RUN ASF UNDR CUSTOM USR, DEN UR ASF PROCES WONT HAS RITE ACCES 2 ITZ OWN FILEZ. DIS ACCES IZ NOT MANDATORY 4 OPERASHUN, BUT IT CRUSHUL E.G. 4 AUTO-UPDATEZ FEACHUR. IN ORDR 2 FIX DIS, IZ ENOUGH 2 CHANGE OWNERSHIP OV ALL ASF FILEZ FRUM DEFAULT asf 2 UR NEW CUSTOM USR.

docker exec -u root asf chown -hR 1001:1001 /app

DIS HAS 2 BE DUN ONLY ONCE AFTR U CREATD UR CONTAINR WIF docker run, AN ONLY IF U DECIDD 2 USE CUSTOM USR 4 ASF PROCES. ALSO DOAN FORGET 2 CHANGE 1001:1001 ARGUMENT IN BOTH COMMANDZ ABOOV 2 TEH uid AN gid U AKSHULLY WANTS 2 RUN ASF UNDR.

MULTIPLE INSTANCEZ SYNCHRONIZASHUN

ASF INCLUDEZ SUPPORT 4 MULTIPLE INSTANCEZ SYNCHRONIZASHUN, AS STATD IN COMPATIBILITY SECSHUN. WHEN RUNNIN ASF IN DOCKR CONTAINR, U CAN OPSHUNALLY "OPT-IN" INTO TEH PROCES, IN CASE URE RUNNIN MULTIPLE CONTAINERS WIF ASF AN UD LIEK 4 THEM 2 SYNCHRONIZE WIF EACH OTHR.

BY DEFAULT, EACH ASF RUNNIN INNA DOCKR CONTAINR IZ STANDALONE, WHICH MEANZ DAT NO SYNCHRONIZASHUN TAKEZ PLACE. IN ORDR 2 ENABLE SYNCHRONIZASHUN TWEEN THEM, U MUST BIND /tmp/ASF PATH IN EVRY ASF CONTAINR DAT U WANTS 2 SYNCHRONIZE, 2 WAN, SHARD PATH ON UR DOCKR HOST, IN READ-RITE MODE. DIS AR TEH ACHIEVD EGSAKTLY TEH SAME AS BINDIN VOLUME WHICH WUZ DESCRIBD ABOOV, JUS WIF DIFFERENT PATHS:

mkdir -p /tmp/ASF-g1
docker run -v /tmp/ASF-g1:/tmp/ASF -v /home/archi/ASF/config:/app/config --name asf1 --pull always justarchi/archisteamfarm
docker run -v /tmp/ASF-g1:/tmp/ASF -v /home/john/ASF/config:/app/config --name asf2 --pull always justarchi/archisteamfarm
# AN SO ON, ALL ASF CONTAINERS R NAO SYNCHRONIZD WIF EACH OTHR

WE RECOMMEND 2 BIND ASFS /tmp/ASF DIRECTORY ALSO 2 TEMPORARY /tmp DIRECTORY ON UR MACHINE, BUT OV COURSE URE FREE 2 CHOOSE ANY OTHR WAN DAT SATISFIEZ UR USAGE. EACH ASF CONTAINR DAT IZ EXPECTD 2 BE SYNCHRONIZD SHUD HAS ITZ /tmp/ASF DIRECTORY SHARD WIF OTHR CONTAINERS DAT R TAKIN PART IN DA SAME SYNCHRONIZASHUN PROCES.

AS UVE PROBABLY GUESD FRUM EXAMPLE ABOOV, IZ ALSO POSIBLE 2 CREATE 2 OR MOAR "SYNCHRONIZASHUN GROUPS", BY BINDIN DIFFERENT DOCKR HOST PATHS INTO ASFS /tmp/ASF.

MOUNTIN /tmp/ASF IZ COMPLETELY OPSHUNAL AN AKSHULLY NOT RECOMMENDD, UNLES U EXPLICITLY WANTS 2 SYNCHRONIZE 2 OR MOAR ASF CONTAINERS. WE DO NOT RECOMMEND MOUNTIN /tmp/ASF 4 SINGLE-CONTAINR USAGE, AS IT BRINGS ABSOLUTELY NO BENEFITS IF U EXPECT 2 RUN JUS WAN ASF CONTAINR, AN IT MITE AKSHULLY CAUSE ISSUEZ DAT CUD OTHERWIZE BE AVOIDD.

COMMAND-LINE ARGUMENTS

ASF ALLOWS U 2 PAS COMMAND-LINE ARGUMENTS IN DOCKR CONTAINR THRU ENVIRONMENT VARIABLEZ. U SHUD USE SPECIFIC ENVIRONMENT VARIABLEZ 4 SUPPORTD SWITCHEZ, AN ASF_ARGS 4 DA REST. DIS CAN BE ACHIEVD WIF -e SWITCH ADDD 2 docker run, 4 EXAMPLE:

docker run -it -e "ASF_CRYPTKEY=MyPassword" -e "ASF_ARGS=--no-config-migrate" --name asf --pull always justarchi/archisteamfarm

DIS WILL PROPERLY PAS UR --cryptkey ARGUMENT 2 ASF PROCES BEAN RUN INSIDE DOCKR CONTAINR, AS WELL AS OTHR ARGS. OV COURSE, IF URE ADVANCD USR DEN U CAN ALSO MODIFY ENTRYPOINT OR ADD CMD AN PAS UR CUSTOM ARGUMENTS YOURSELF.

UNLES U WANTS 2 PROVIDE CUSTOM ENCRYPSHUN KEY OR OTHR ADVANCD OPSHUNS, USUALLY U DOAN NED 2 INCLUDE ANY SPESHUL ENVIRONMENT VARIABLEZ, AS R DOCKR CONTAINERS R ALREADY CONFIGURD 2 RUN WIF SANE EXPECTD DEFAULT OPSHUNS OV --no-restart --process-required --system-required, SO DOSE FLAGS DO NOT NED 2 BE SPECIFID EXPLICITLY IN ASF_ARGS.

IPC

ASSUMIN U DIDNT CHANGE TEH DEFAULT VALUE 4 IPC GLOBAL CONFIGURASHUN PROPERTY, IZ ALREADY ENABLD. HOWEVR, U MUST DO 2 ADDISHUNAL THINGS 4 IPC 2 WERK IN DOCKR CONTAINR. FIRSTLY, U MUST USE IPCPassword OR MODIFY DEFAULT KnownNetworks IN CUSTOM IPC.config 2 ALLOW U 2 CONNECT FRUM TEH OUTSIDE WITHOUT USIN WAN. UNLES U RLY KNOE WUT URE DOIN, JUS USE IPCPassword. SECONDLY, U HAS 2 MODIFY DEFAULT LISTENIN ADDRES OV localhost, AS DOCKR CANT ROUTE OUTSIDE TRAFFIC 2 LOOPBACK INTERFACE. AN EXAMPLE OV SETTIN DAT WILL LISTEN ON ALL INTERFACEZ WUD BE http://*:1242. OV COURSE, U CAN ALSO USE MOAR RESTRICTIV BINDINGS, SUCH AS LOCAL LAN OR VPN NETWORK ONLY, BUT IT HAS 2 BE ROUTE ACCESIBLE FRUM TEH OUTSIDE - localhost WONT DO, AS TEH ROUTE IZ ENTIRELY WITHIN GUEST MACHINE.

4 DOIN TEH ABOOV U SHUD USE CUSTOM IPC CONFIG SUCH AS TEH WAN BELOW:

{
    "Kestrel": {
        "Endpoints": {
            "HTTP": {
                "Url": "http://*:1242"
            }
        }
    }
}

ONCE WE SET UP IPC ON NON-LOOPBACK INTERFACE, WE NED 2 TELL DOCKR 2 MAP ASFS 1242/tcp PORT EITHR WIF -P OR -p SWITCH.

4 EXAMPLE, DIS COMMAND WUD EXPOSE ASF IPC INTERFACE 2 HOST MACHINE (ONLY):

docker run -it -p 127.0.0.1:1242:1242 -p [::1]:1242:1242 --name asf --pull always justarchi/archisteamfarm

IF U SET EVRYTHIN PROPERLY, docker run COMMAND ABOOV WILL MAK IPC INTERFACE WERK FRUM UR HOST MACHINE, ON STANDARD localhost:1242 ROUTE DAT IZ NAO PROPERLY REDIRECTD 2 UR GUEST MACHINE. IZ ALSO NICE 2 NOWT DAT WE DO NOT EXPOSE DIS ROUTE FURTHR, SO CONNECSHUN CAN BE DUN ONLY WITHIN DOCKR HOST, AN THEREFORE KEEPIN IT SECURE. OV COURSE, U CAN EXPOSE TEH ROUTE FURTHR IF U KNOE WUT URE DOIN AN ENSURE APPROPRIATE SECURITY MEASUREZ.

COMPLETE EXAMPLE

COMBININ WHOLE KNOWLEDGE ABOOV, AN EXAMPLE OV COMPLETE SETUP WUD LOOK LIEK DIS:

docker run -it -p 127.0.0.1:1242:1242 -p [::1]:1242:1242 -v /home/archi/ASF/config:/app/config --name asf --pull always justarchi/archisteamfarm

DIS ASSUMEZ DAT ULL USE SINGLE ASF CONTAINR, WIF ALL ASF CONFIG FILEZ IN /home/archi/ASF/config. U SHUD MODIFY TEH CONFIG PATH 2 TEH WAN DAT MATCHEZ UR MACHINE. DIS SETUP IZ ALSO READY 4 OPSHUNAL IPC USAGE IF UVE DECIDD 2 INCLUDE IPC.config IN UR CONFIG DIRECTORY WIF CONTENT LIEK BELOW:

{
    "Kestrel": {
        "Endpoints": {
            "HTTP": {
                "Url": "http://*:1242"
            }
        }
    }
}

PRO TIPS

WHEN U ALREADY HAS UR ASF DOCKR CONTAINR READY, U DOAN HAS 2 USE docker run EVRY TIEM. U CAN EASILY STOP/START ASF DOCKR CONTAINR WIF docker stop asf AN docker start asf. KEEP IN MIND DAT IF URE NOT USIN latest TAG DEN USIN UP-2-DATE ASF WILL STILL REQUIRE FRUM U 2 docker stop, docker rm AN docker run AGAIN. DIS AR TEH CUZ U MUST REBUILD UR CONTAINR FRUM FRESH ASF DOCKR IMAGE EVRY TIEM U WANTS 2 USE ASF VERSHUN INCLUDD IN DAT IMAGE. IN latest TAG, ASF HAS INCLUDD CAPABILITY 2 AUTO-UPDATE ITSELF, SO REBUILDIN TEH IMAGE IZ NOT NECESARY 4 USIN UP-2-DATE ASF (BUT IZ STILL GUD IDEA 2 DO IT FRUM TIEM 2 TIEM IN ORDR 2 USE FRESH .NET RUNTIME DEPENDENCIEZ AN TEH UNDERLYIN OS).

AS HINTD BY ABOOV, ASF IN TAG OTHR THAN latest WONT AUTOMATICALLY UPDATE ITSELF, WHICH MEANZ DAT U R IN CHARGE OV USIN UP-2-DATE justarchi/archisteamfarm REPO. DIS HAS LOTZ DA ADVANTAGEZ AS TYPICALLY TEH APP SHUD NOT TOUCH ITZ OWN CODE WHEN BEAN RUN, BUT WE ALSO UNDERSTAND CONVENIENCE DAT COMEZ FRUM NOT HAVIN 2 WORRY BOUT ASF VERSHUN IN UR DOCKR CONTAINR. IF U CARE BOUT GUD PRACTICEZ AN PROPR DOCKR USAGE, released TAG IZ WUT WED SUGGEST INSTEAD OV latest, BUT IF U CANT BE BOTHERD WIF IT AN U JUS WANTS 2 MAK ASF BOTH WERK AN AUTO-UPDATE ITSELF, DEN latest WILL DO.

U SHUD TYPICALLY RUN ASF IN DOCKR CONTAINR WIF Headless: true GLOBAL SETTIN. DIS WILL CLEARLY TELL ASF DAT URE NOT HER 2 PROVIDE MISIN DETAILS AN IT SHUD NOT ASK 4 DOSE. OV COURSE, 4 INITIAL SETUP U SHUD CONSIDR LEAVIN DAT OPSHUN AT false SO U CAN EASILY SET UP THINGS, BUT IN LONG-RUN URE TYPICALLY NOT ATTACHD 2 ASF CONSOLE, THEREFORE ITD MAK SENSE 2 INFORM ASF BOUT DAT AN USE input COMMAND IF NED ARISEZ. DIS WAI ASF WONT HAS 2 WAIT INFINITELY 4 USR INPUT DAT WILL NOT HAPPEN (AN WASTE RESOURCEZ WHILE DOIN SO). IT WILL ALSO ALLOW ASF 2 RUN IN NON-INTERACTIV MODE INSIDE CONTAINR, WHICH IZ CRUSHUL E.G. IN REGARDZ 2 FORWARDIN SIGNALS, MAKIN IT POSIBLE 4 ASF 2 GRACEFULLY CLOSE ON docker stop asf REQUEST.